mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-10-07 14:27:30 +00:00
Merge pull request #2577 from AdityaGoyal1999/docs-fix
Updated docs to use docker compose instead of docker-compose
This commit is contained in:
@@ -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,7 +15,6 @@ 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
|
||||||
@@ -26,8 +25,9 @@ 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.
|
||||||
@@ -36,7 +36,7 @@ Once all the services have spun up, browse to http://localhost:8080.
|
|||||||
|
|
||||||
```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,6 +56,7 @@ 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
|
||||||
|
|||||||
Reference in New Issue
Block a user