Spokes Deployment

This repository contains the deployment templates and instructions for Spokes, a secure, self-hosted team communication platform.

Deploying with Portainer (1-Click)

The easiest way to deploy Spokes is via Portainer's App Templates.

1. Open your Portainer instance.
2. Navigate to Settings -> App Templates.
3. Under "Use custom templates", enter the following URL: https://spokes.sh/templates.json
4. Click Save settings.
5. Navigate to App Templates in the sidebar. You will now see Spokes!
6. Click on Spokes, enter a secure Master Password, and click Deploy the stack.

Deploying manually with Docker Compose

If you prefer to deploy Spokes manually via the command line:

1. Clone this repository or download the docker-compose.yml file.
2. In the same directory as the docker-compose.yml file, create a .env file with your master password:

   SPOKES_MASTER_PASSWORD=YourSecurePasswordHere

3. Run the following command to start the server:

   docker compose up -d

For more detailed deployment guides, please refer to the official Spokes documentation.