changLiuUNSW/cumulus

Our vision of the self-hosted cloud, done right. Using state of the art technologies and frameworks, Cumulus aims to be the flawless experience you always wanted. Easy to deploy, fast, secure and with a beautiful UI.

Deploy and use Cumulus

We recommend using docker and docker-compose to easily manage and deploy the Cumulus app.

Official docker image

cumuluscloud/cumulus

Using docker compose

To run the cumulus server with docker-compose using the latest build you will need a docker-compose.yml file looking like this:

version: '3.4'
services:

  cumulus_app:
    image: cumuluscloud/cumulus:latest
    ports:
      - 80:9000
    environment:
      DB_URL: "jdbc:postgresql://cumulus_db/cumulus"
      DB_USER: cumulus
      DB_PASSWORD: <Your password>
      APPLICATION_SECRET: <Your app secret>
    volumes:
      - ./cumulus-storage:/opt/cumulus/storage
      - ./cumulus-log:/opt/cumulus/log
    depends_on:
      - cumulus_db
    restart: on-failure
    command: /opt/cumulus/bin/cumulus-server

  cumulus_db:
    image: postgres:10-alpine
    environment:
      POSTGRES_DB: cumulus
      POSTGRES_USER: cumulus
      POSTGRES_PASSWORD: <Your password>
    volumes:
      - ./cumulus-db:/var/lib/postgresql/data

Alternatively, you can also build the docker yourself by compiling the project:

cd server && sbt stage

And then using the provided Dockerfile in your docker-compose file:

...
  cumulus_app:
    build: .
...

For more information on how to build the app, please refer to the corresponding section of this readme.

Manually

TODO

Building

Webapp (Font)

Refer to the corresponding readme

Server (Back)