Update the README.md and the docker-compose files.
This commit is contained in:
@@ -18,6 +18,11 @@ cp .env.example .env
|
||||
```
|
||||
Edit the `.env` file with your specific configuration values.
|
||||
|
||||
### 3. Loop Server Environment Configuration
|
||||
|
||||
Check and edit, if required, the `docker-compose.yml` file for your specific configuration requirements. The current values are default and will ensure a working deployment. Some values will be populated on deployment from the `.env` file.
|
||||
|
||||
|
||||
### 3. Start the Services
|
||||
```bash
|
||||
docker-compose up -d
|
||||
@@ -42,15 +47,20 @@ docker-compose logs -f [service-name]
|
||||
|
||||
| Variable | Description | Required |
|
||||
|----------|-------------|----------|
|
||||
| `APP_ENV` | Application environment | Yes |
|
||||
| `APP_PORT` | Port the app runs on | Yes |
|
||||
| `DB_PASSWORD` | Database password | Yes |
|
||||
| `SECRET_KEY` | Application secret key | Yes |
|
||||
| `SITEURL` | Loop-server URL | Yes |
|
||||
| `HTTP_PROTOCOL` | https://(Preferred) or http:// | Yes |
|
||||
| `GIPHYSDKKEY` | GIPHYSDKKEY | Yes |
|
||||
| `PG_PASSWORD` | Database password | Yes |
|
||||
| `PG_USER` | Database user | Yes |
|
||||
| `PG_DB_NAME` | Database name | Yes |
|
||||
| `MINIO_ROOT_USER` | minio root user | Yes |
|
||||
| `MINIO_ROOT_PASSWORD` | minio root user password | Yes |
|
||||
| `ACCESS_KEY_ID` | S3 access key | Yes |
|
||||
| `SECRET_ACCESS_KEY` | S3 secret key | Yes |
|
||||
| `BUCKET_NAME` | S3 bucket name | Yes |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **Port conflicts**: Change `APP_PORT` in `.env` file
|
||||
- **Database errors**: Check `DB_PASSWORD` is correct
|
||||
- **View service logs**: `docker-compose logs [service_name]`
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user