chore(): docker-compose
This commit is contained in:
38
README.md
38
README.md
@@ -2,28 +2,24 @@ docker run --rm -p 3030:3000 gotenberg/gotenberg:8
|
||||
|
||||
## Configuration
|
||||
|
||||
This application is configured using a `config.json` file in the root of the project. You can use the `config.json.example` file as a starting point.
|
||||
This application can be configured using a `config.json` file in the root of the project, or by using environment variables. Values set in environment variables will override the values from the `config.json` file.
|
||||
|
||||
```json
|
||||
{
|
||||
"email": {
|
||||
"smtp": {
|
||||
"host": "smtp.example.com",
|
||||
"port": 587,
|
||||
"username": "user",
|
||||
"password": "password"
|
||||
},
|
||||
"from": "from@example.com"
|
||||
},
|
||||
"pdf": {
|
||||
"hostname": "http://localhost:3030"
|
||||
},
|
||||
"gitea": {
|
||||
"url": "https://gitea.example.com",
|
||||
"token": "your-gitea-token"
|
||||
}
|
||||
}
|
||||
```
|
||||
You can use the `config.example.json` file as a starting point for your `config.json`.
|
||||
|
||||
### Environment Variables
|
||||
|
||||
The following environment variables can be used for configuration:
|
||||
|
||||
| Variable | Description |
|
||||
| --------------------- | --------------------------------------------- |
|
||||
| `PDF_HOSTNAME` | The hostname of the PDF generator (Gotenberg) |
|
||||
| `GITEA_URL` | The URL of your Gitea instance |
|
||||
| `GITEA_TOKEN` | Your Gitea API token |
|
||||
| `EMAIL_FROM` | The "From" address for sending emails |
|
||||
| `EMAIL_SMTP_HOST` | The SMTP server host |
|
||||
| `EMAIL_SMTP_PORT` | The SMTP server port |
|
||||
| `EMAIL_SMTP_USER` | The username for SMTP authentication |
|
||||
| `EMAIL_SMTP_PASSWORD` | The password for SMTP authentication |
|
||||
|
||||
## API Endpoints
|
||||
|
||||
|
||||
Reference in New Issue
Block a user