Fork and clone the repo
Once, you’ve done that, create a new branch:
git checkout -b MY_BRANCH_NAME
Set up environment variables
Start by creating a .env file at the root of the Infisical directory then copy the contents of the file below into the .env file.
The pre-populated environment variable values above are meant to be used in development only. They should never be used in production.
View all available environment variables and guidance for each.
Starting Infisical for development
We use Docker to spin up all required services for Infisical in local development. If you are unfamiliar with Docker, don’t worry, all you have to do is install Docker for your machine and run the command below to start up the development server.
Start local server
docker-compose -f docker-compose.dev.yml up --build --force-recreate
Access local server
Once all the services have spun up, browse to http://localhost:8080. To sign in, you may use the default credentials listed below.
Shutdown local server
# To stop environment use Control+C (on Mac) CTRL+C (on Win) or docker-compose -f docker-compose.dev.yml down
Starting Infisical docs locally
We use Mintlify for our docs.
Install Mintlify CLI.
npm i -g mintlify
yarn global add mintlify
Running the docs
docs directory and run
mintlify dev. This will start up the docs on
# From the root directory cd docs; mintlify dev;