70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
# Loop Server Docker Compose
|
|
|
|
## Overview
|
|
|
|
This repository contains the Docker Compose configuration and deployment files for the Loop server.
|
|
|
|
## Quick Start
|
|
|
|
### 1. Clone the Repository
|
|
```bash
|
|
git clone https://git.wilix.dev/wilix-infra/loop-onprem-docker.git
|
|
cd loop-onprem-docker
|
|
```
|
|
|
|
### 2. Environment Configuration
|
|
```bash
|
|
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.
|
|
|
|
|
|
### 4. Start the Services
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
### 5. Verify Deployment
|
|
```bash
|
|
docker-compose ps
|
|
docker-compose logs -f [service-name]
|
|
```
|
|
|
|
## Useful Commands
|
|
|
|
| Action | Command |
|
|
|--------|---------|
|
|
| Start services | `docker-compose up -d` |
|
|
| Stop services | `docker-compose down` |
|
|
| View logs | `docker-compose logs -f` |
|
|
| Restart services | `docker-compose restart` |
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Description | Required |
|
|
|----------|-------------|----------|
|
|
| `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 |
|
|
|
|
## TO-DO: add SSL cert details for https
|
|
|
|
## Troubleshooting
|
|
|
|
- **View service logs**: `docker-compose logs [service_name]`
|
|
|
|
## License
|
|
|
|
[License type] - See LICENSE file for details. |