Skip to content

Commit

Permalink
fix: Documentation for environment variables
Browse files Browse the repository at this point in the history
  • Loading branch information
@pettermachado
pettermachado committed Oct 8, 2024
1 parent 888ca0c commit 7ab70b7
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,20 @@ cp .env.sample .env
# Add your token to the .env file
```

## Environment variables

| Environment variable | Default | Description |
| ---------------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `DB_CACHE` | - | When set to anything truthy cached values will be stored in the database. |
| `DB_URI` | - | Will be passed to `new Sequelize(dbUri)` when set. |
| `DB_STORAGE` | `db.sqlite` | Used in combination with the default databse setup. The name of the file that `sqlite` uses as database. |
| `SYNC_DB` | - | When set to anything truthy will sync all database tables. **Note: All your data will be deleted**. |
| `LOG_LEVEL` | `info` when `NODE_ENV=production` else `debug` | The log level passed to `pino({ level: logLevel })`. |
| `SOUNDTRACK_API_URL` | - | The url of the Soundtrack API. |
| `SOUNDTRACK_API_TOKEN` | - | The Soundtrack API token, used in all requests towards the Soundtrack API. |
| `REQUEST_LOG` | - | when set the anything truthy will enable http request logs. |
| `WORKER_INTERVAL` | `60` | The worker check interval in seconds. |

## Deployment

### Security
Expand Down

0 comments on commit 7ab70b7

Please sign in to comment.