marmelab/comfygure repository overview

⁠What is Comfygure?

Comfygure is an encrypted and versioned configuration store built with collaboration in mind.

This docker image allows you to host your own comfygure storage that can be used with the Comfy CLI⁠ to manage your configurations.

⁠Get Started

Comfygure requires a PostgreSQL instance⁠ to store the configs, so let's start by that :

# Create a docker network in order to let comfygure reach the postgres container
docker network create comfy-network

# Grab the initial database schema on the repo
wget https://raw.githubusercontent.com/marmelab/comfygure/master/api/var/schema.sql

# Start the postgres container with the initial schema
docker run --name comfy-postgres \
    -e POSTGRES_PASSWORD=mysecretpassword \
    -v `pwd`/schema.sql:/docker-entrypoint-initdb.d/schema.sql \
    --network comfy-network \
    -d  postgres

# Run comfygure container and expose its port
docker run --name comfygure-api \
    -e PGHOST=comfy-postgres \
    -e PGDATABASE=postgres \
    -e PGPASSWORD=mysecretpassword \
    --network comfy-network \
    -p 3000:80 \
    -d marmelab/comfygure

Your comfygure API container is now up and running at http://localhost:3000⁠, and you can use it with the comfy CLI to manage your configs.

npm install -g comfygure
comfy init --origin http://localhost:3000

Initializing project configuration...
Project created on comfy server http://localhost:3000
Configuration saved locally in .comfy/config
comfy project successfully created

⁠Environment Variables

The comfygure API doesn't require much configuration other than to plug the postgres, here are all the environment variables you can use to tune it.

To be noted that the container has a configuration validation at the server start : if one of these environment variables is invalid, the container will crash and you'll be able to understand why by running docker log comfygure-api

⁠COMFY_API_PORT (default: 80)

⁠COMFY_LOG_DEBUG (default: false)

⁠PGHOST (default: localhost)

⁠PGPORT (default: 5432)

⁠PGDATABASE (default: comfy)

⁠PGUSER (default: postgres)

⁠PGPASSWORD (default: '')

It is highly recommended to set a default root password.

⁠License

Comfygure⁠ is licensed under the MIT License⁠, sponsored and supported by marmelab⁠.