postiz/README.md

47 lines
1.4 KiB
Markdown

<!-- build 0 -->
# Postiz
## Deployment
This project uses Woodpecker CI for continuous integration and deployment to staging and production environments.
### Woodpecker CI Configuration
The `.woodpecker.yml` file defines the CI/CD pipeline with the following steps:
- Building and pushing Docker images for staging
- Deploying to staging environment
- Cleaning up staging environment
- Building and pushing Docker images for production
- Deploying to production environment
### Required Secrets
The following secrets need to be configured in your Woodpecker CI instance:
#### Registry and Docker Hub Access
- `REGISTRY_USER` - Registry username
- `REGISTRY_PASSWORD` - Registry password
- `DOCKER_REGISTRY_USER` - Docker Hub username
- `DOCKER_REGISTRY_PASSWORD` - Docker Hub password
#### Production Environment Variables
The following secrets are injected into the `stack.production.yml` file during deployment:
- `PROD_POSTGRES_PASSWORD` - PostgreSQL database password
- `PROD_POSTGRES_USER` - PostgreSQL username
- `PROD_POSTGRES_DB` - PostgreSQL database name
- `PROD_JWT_SECRET` - Secret key for JWT token generation
- `PROD_MAIN_URL` - Main application URL
- `PROD_FRONTEND_URL` - Frontend URL
- `PROD_NEXT_PUBLIC_BACKEND_URL` - Backend URL for public access
- `PROD_LINKEDIN_CLIENT_ID` - LinkedIn OAuth client ID
- `PROD_LINKEDIN_CLIENT_SECRET` - LinkedIn OAuth client secret
## Development
To run the application locally:
```bash
docker compose up --build
```