Quick Start Guide
This guide provides a brief overview of how to get started with SAFE.
Download SAFE
First, you will need to download SAFE to your local machine. You can find the download instructions on the Download SAFE CLI page.
Setup SAFE for your project
The next step is to setup SAFE for your Erlang/Elixir project. You can do this by using the SAFE CLI.
During the setup process, a fingerprint.json file and a config.json file will be generated.
To set up SAFE, run SAFE's setup command in your project directory. Detailed instructions can be found on the Setting up SAFE page.
After the setup process has been completed, please send us the generated fingerprint.json file to safe@erlang-solutions.com to help generate the License for the project. If you are a maintainer of an open-source project, you may be eligible for a free license. Please include the URL of the project in the email.
Configure SAFE in your CI/CD pipeline
SAFE offers out-of-the-box integration with many CI/CD systems, through Docker. You can find detailed instructions on how to set up SAFE in your CI/CD pipeline on the CI/CD Integration page. If you are using a different CI/CD system, please do not hesitate to contact us.
Review the Results
After the successful execution of SAFE in your CI/CD pipeline, you will receive a detailed report highlighting any vulnerabilities found in your codebase. You can review these results to understand and address potential security issues. If you configured SAFE to print the results to the console, you can see them directly in your CI/CD job logs. If you also configured it to generate the report file, you can find it also on the disk. (Please refer to the Configuration page for more details on configuring the output options.)
Support
If you encounter any issues or have questions while using SAFE, please feel free to reach out to us.