Skip to content

Commit

Permalink
Update .gitignore and Add README Instructions (#123)
Browse files Browse the repository at this point in the history
* Fixed script and compose

* fixed readme

* Update load_mongodump.sh
  • Loading branch information
TeachMeTW authored Sep 10, 2024
1 parent dfecdd9 commit 94b67e0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ __pycache__
assets/qrcodes
data/tokens.csv
config.py
docker-compose-dev.yml
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,24 @@ docker-compose -f docker-compose-prod-nginx.yml up -d
The dash component assumes that it is running from the host root, and will barf if you try to run it behind a reverse proxy with a different file prefix.
This setting tests that configuration using an embedded reverse proxy in the docker container.

## Working with `docker compose` and `.gitignore`

### Using `docker compose`

When working with `docker compose`, it's generally recommended to avoid committing changes to the `docker-compose-dev.yml` file, especially if you're running the `./load_mongodump <dump tar>` script. This file is typically configured to work in a specific way for your development environment, and changes might not be applicable or useful for others working on the same project.

### `.gitignore` Configuration

To streamline your workflow, we have added the `docker-compose-dev.yml` file to the `.gitignore` file. This means that by default, changes to `docker-compose-dev.yml` will not be tracked by Git. This setup helps to avoid unnecessary commits and ensures that your `docker-compose-dev.yml` remains consistent with the intended configuration for the project.

### Committing Changes to `docker-compose-dev.yml`

If you do need to make changes to `docker-compose-dev.yml` and want to commit those changes, you can override the ignore settings by using the following Git command:

```bash
git add -f docker-compose-dev.yml
```

# Dynamic Config

## Set Variables
Expand Down
2 changes: 1 addition & 1 deletion docker-compose-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ services:
DASH_DEBUG_MODE: "True"
DASH_SILENCE_ROUTES_LOGGING: "False"
DASH_SERVER_PORT: 8050
DB_HOST: mongodb://db/openpath_prod_ca_ebike
DB_HOST: mongodb://db/DB_NAME
WEB_SERVER_HOST: 0.0.0.0
SERVER_BRANCH: master
CONFIG_PATH: "https://raw.githubusercontent.com/e-mission/nrel-openpath-deploy-configs/main/configs/"
Expand Down

0 comments on commit 94b67e0

Please sign in to comment.