Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/audiusproject/audius-docker-compose
https://github.com/audiusproject/audius-docker-compose
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/audiusproject/audius-docker-compose
- Owner: AudiusProject
- Created: 2022-03-31T15:55:15.000Z (over 2 years ago)
- Default Branch: stage
- Last Pushed: 2024-11-12T20:02:18.000Z (about 1 month ago)
- Last Synced: 2024-11-12T21:18:17.057Z (about 1 month ago)
- Language: Python
- Size: 4.68 MB
- Stars: 12
- Watchers: 8
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
audius-cli
🚀 🎧 🐳
Launch and manage Audius services using Docker Compose
> Hardware [requirements](https://docs.audius.org/token/running-a-node/hardware-requirements)
## Installation
On a VM that meets the minimum requirements from above run:
```sh
bash <(curl https://raw.githubusercontent.com/AudiusProject/audius-docker-compose/main/install.sh)
```
During installation there will be prompts for required environment variables.
After setting the variables, they are exported to an `override.env` file in the respective service directory.
### Content Node (Creator Node)
| Variable | Description | Example |
| ----------- | ----------- | ----------- |
| creatorNodeEndpoint | The DNS of your content node. If you haven't registered the service yet, please enter the url you plan to register | https://cn1.operator.xyz |
| delegateOwnerWallet | Public key for the service used to sign responses from the server. This wallet holds no tokens. | `0x07bC80Cc29bb15a5CA3D9DB9D80AcA25eB967aFc` |
| delegatePrivateKey | Private key associated with `delegateOwnerWallet` | `2ef5a28ab4c39199085eb4707d292c980fef3dcc9dc854ba8736a545c11e81c4` |
| spOwnerWallet | Public key that registered (or will register) the content node on chain. This wallet holds tokens. | `0x92d3ff660158Ec716f1bA28Bc65a7a0744E26A98` |
### Discovery Node (Discovery Provider)
| Variable | Description | Example |
| ----------- | ----------- | ----------- |
| audius_discprov_url | The DNS of the discovery node. If you haven't registered the service yet, please enter the url you plan to register | https://dn1.operator.xyz |
| audius_delegate_owner_wallet | Public key for the service used to sign responses from the server. This wallet holds no tokens. | `0x07bC80Cc29bb15a5CA3D9DB9D80AcA25eB967aFc` |
| audius_delegate_private_key | Private key associated with `audius_delegate_owner_wallet` | `2ef5a28ab4c39199085eb4707d292c980fef3dcc9dc854ba8736a545c11e81c4` |
### Customizing override.env
If you would like to maintain environment variables externally to the repository, you can use the following commands to override the path for the `override.env` file
```
audius-cli set-override-path discovery-provider
audius-cli set-override-path discovery-provider --unset
```
## Upgrading
You can upgrade your service to the latest release by setting up autoupgrade:
```
audius-cli auto-upgrade
```
Or manually:
```
audius-cli upgrade
```
## Logging
Logging is enabled by _default_ to stream logs to an external logging service for debugging purposes. It is *strongly* recommended to keep logging enabled. The Audius logging stack uses [vector.dev](vector.dev) to ship container logs.
If there's a reason to turn logging off, it can be disabled via config:
```
audius-cli set-config discovery-provider audius_logging_disabled true
audius-cli launch discovery-provider
```
## SSL configuration
[Caddy](https://caddyserver.com/) will automatically obtain certs from Let's Encrypt provided the following is true:
* DNS points to your machine
* The `audius_discprov_url` or `creatorNodeEndpoint` matches the DNS name. (e.g. `https://discovery2.myhost.com`... **no trailing slash!**)
* Ports 80 and 443 are open to the internet
If SSL is not working after a minute, `docker logs caddy` can provide clues.
### SSL with CloudFlare Proxy
If you are using CloudFlare Proxy, configure Caddy to generate a self-signed cert instead of using Let's Encrypt.
For Creator Node:
```
audius-cli set-config creator-node CADDY_TLS 'tls internal'
audius-cli launch creator-node
```
For Discovery Provider:
```
audius-cli set-config discovery-provider CADDY_TLS 'tls internal'
audius-cli launch discovery-provider
```
For DDEX:
```
audius-cli set-config ddex CADDY_TLS 'tls internal'
audius-cli launch ddex
```
## Utilities
The [utilities folder](/utilities/) contains a set of scripts and utilities to manage services like:
- Running pre-registration health checks
- Automatic rewards claim script
## Advanced options
For more advanced configuration options or migrating from Kubernetes check out the [Advanced Setup Guide](ADVANCED_SETUP.md)
## DDEX setup (advanced)
Audius provides the option to self-host your own [Digital Data Exchange (DDEX)](https://kb.ddex.net) implementation. To run one of the existing implementations on your own infrastructure:
1. Follow the regular instructions above to run install.sh, and choose "ddex" as the service to install.
2. Edit ddex/override.env to have a value for each environment variable
- See [here](https://github.com/AudiusProject/audius-protocol/tree/main/packages/ddex#readme) for instructions on how to setup your S3 buckets, as well as the environment variable options
3. `audius-cli launch ddex`
4. Enable auto-upgrade: `audius-cli auto-upgrade "* * * * *"`
5. Make sure you've set the `DDEX_URL` environment variable to the URL that will host this server, and see "SSL Configuration" above for SSL setup