Skip to content

Commit

Permalink
Add deployment instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
targoninc-alex committed Apr 20, 2024
1 parent 1f4a74e commit 87f401d
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,3 +73,32 @@ You can export and import your graph by clicking the "Download JSON" and "Upload
# Credits

- Font used in Logo - [Excon by Indian Type Foundry](https://www.fontshare.com/fonts/excon)

# CI/CD

## Set up Github Actions Secrets

- `REGISTRY_HOST` - The host of the registry (e.g. `ghcr.io`)
- `REGISTRY_USER` - The username of the registry
- `REGISTRY_PASS` - The password for the given username

## Deployment

The `docker-image.yml` workflow will push the image to the registry on every push to the `main` branch.
You can then deploy it with a docker-compose file like this:

```yaml
services:
nodiris:
image: ${REGISTRY_HOST}/${IMAGE_NAME}:latest
container_name: NODIRIS
restart: always
environment:
- DEPLOYMENT_URL=${DEPLOYMENT_URL}
- MYSQL_URL=${MYSQL_URL}
- MYSQL_USER=${MYSQL_USER}
- MYSQL_PASSWORD=${MYSQL_PASSWORD}
- SESSION_SECRET=${SESSION_SECRET}
ports:
- "${PORT_NODIRIS}:3001"
```

0 comments on commit 87f401d

Please sign in to comment.