diff --git a/deployment/README.md b/deployment/README.md index 61137095b..39c9f4925 100644 --- a/deployment/README.md +++ b/deployment/README.md @@ -3,9 +3,13 @@ not optimal, but can get you started easily and cheaply. To run: 1. Set up a `.env` file in this directory with relevant environment variables. - Use the `env.template` as a reference. + + 2. SKIP this step if running locally. If you are running this for production and need https do the following: - Set up a `.env.nginx` file in this directory based on `env.nginx.template`. - `chmod +x init-letsencrypt.sh` + `./init-letsencrypt.sh` to set up https certificate. + + 3. Run one of the docker compose commands below depending on your environment: - For Local: - `docker compose -f docker-compose.dev.yml -p danswer-stack up -d --build` @@ -13,8 +17,17 @@ not optimal, but can get you started easily and cheaply. To run: - For Prod: - `docker compose -f docker-compose.prod.yml -p danswer-stack up -d --build` - This will additionally run certbot and start Nginx. + + 4. To shut down the deployment run: + - For Local: + - `docker compose -f docker-compose.dev.yml -p danswer-stack stop` + - For Prod: + - `docker compose -f docker-compose.prod.yml -p danswer-stack stop` + + +5. To completely remove Danswer (**WARNING, this will also erase your indexed data and all users**) run: - For Local: - `docker compose -f docker-compose.dev.yml -p danswer-stack down` - For Prod: - - `docker compose -f docker-compose.prod.yml -p danswer-stack down` + - `docker compose -f docker-compose.prod.yml -p danswer-stack down` \ No newline at end of file