@comapeo/cloud

@comapeo/cloud

A self-hosted cloud server for CoMapeo.

Deploying CoMapeo Cloud

CoMapeo Cloud can be deployed using Docker. The official Docker image is available on Docker Hub at communityfirst/comapeo-cloud.

Using Docker

Pull and run the latest version:

docker run -d \
  -p 8080:8080 \
  -e SERVER_BEARER_TOKEN=<your-secret-token> \
  -v /path/to/data:/usr/src/app/data \
  communityfirst/comapeo-cloud:latest

Or use the Dockerfile to build a Docker image.

Server configuration is done using environment variables. The following environment variables are available:

Environment Variable	Required	Description	Default Value
SERVER_BEARER_TOKEN	Yes	Token for authenticating API requests. Should be large random string
PORT	No	Port on which the server runs	8080
SERVER_NAME	No	Friendly server name, seen by users when adding server	CoMapeo Server
ALLOWED_PROJECTS	No	Number of projects allowed to register with the server	1
STORAGE_DIR	No	Path for storing app & project data	$CWD/data

If you are using Nginx to act as a reverse proxy for your CoMapeo Cloud server, ensure your proxy headers are configured to support WebSockets.

Deploying with fly.io

CoMapeo Cloud can be deployed on fly.io using the following steps:

• Install the flyctl CLI tool by following the instructions here.
• Create a new app on fly.io by running flyctl apps create, take a note of the app name.
• Set the SERVER_BEARER_TOKEN secret via:

  flyctl secrets set SERVER_BEARER_TOKEN=<your-secret> --app <your-app-name>
  

• Deploy the app by running (optionally setting the ALLOWED_PROJECTS environment variable):

  flyctl deploy --app <your-app-name> -e ALLOWED_PROJECTS=10
  

• The app should now be running on fly.io. You can access it at https://<your-app-name>.fly.dev.

To destroy the app (delete all data and project invites), run:

[!WARNING] This action is irreversible and will permanently delete all data associated with the app, and projects that have already added the server will no longer be able to sync with it.

flyctl destroy --app <your-app-name>