awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-10-06 02:26:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs to use docker compose instead of docker-compose

Browse Source
This commit is contained in:
Aditya Goyal
2024-10-12 15:31:41 -04:00
parent 09d28156f8
commit c176a20010
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contributing/platform/developing.mdx
+11 -10
View File
@@ -1,6 +1,6 @@
--- ---
title: 'Local development' title: "Local development"
description: 'This guide will help you set up and run the Infisical platform in local development.' description: "This guide will help you set up and run the Infisical platform in local development."
--- ---
## Fork and clone the repo ## Fork and clone the repo
@@ -15,28 +15,28 @@ git checkout -b MY_BRANCH_NAME
## Set up environment variables ## Set up environment variables
Start by creating a .env file at the root of the Infisical directory then copy the contents of the file linked [here](https://github.com/Infisical/infisical/blob/main/.env.example). View all available [environment variables](https://infisical.com/docs/self-hosting/configuration/envars) and guidance for each. Start by creating a .env file at the root of the Infisical directory then copy the contents of the file linked [here](https://github.com/Infisical/infisical/blob/main/.env.example). View all available [environment variables](https://infisical.com/docs/self-hosting/configuration/envars) and guidance for each.
## Starting Infisical for development ## 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 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. machine and run the command below to start up the development server.
#### Start local server #### Start local server
```bash ```bash
docker-compose -f docker-compose.dev.yml up --build --force-recreate docker compose -f docker-compose.dev.yml up --build --force-recreate
``` ```
#### Access local server
#### Access local server
Once all the services have spun up, browse to http://localhost:8080. Once all the services have spun up, browse to http://localhost:8080.
#### Shutdown local server #### Shutdown local server
```bash ```bash
# To stop environment use Control+C (on Mac) CTRL+C (on Win) or # To stop environment use Control+C (on Mac) CTRL+C (on Win) or
docker-compose -f docker-compose.dev.yml down docker compose -f docker-compose.dev.yml down
``` ```
## Starting Infisical docs locally ## Starting Infisical docs locally
@@ -56,9 +56,10 @@ yarn global add mintlify
``` ```
#### Running the docs #### Running the docs
Go to `docs` directory and run `mintlify dev`. This will start up the docs on `localhost:3000` Go to `docs` directory and run `mintlify dev`. This will start up the docs on `localhost:3000`
```bash ```bash
# From the root directory # From the root directory
cd docs; mintlify dev; cd docs; mintlify dev;
``` ```