Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.26 KB

README.md

File metadata and controls

57 lines (40 loc) · 2.26 KB

Scripts for deploying Onezone @ hub.crmdr.org

Prerequisites

Prepare a host with the following:

  • git
  • docker
  • docker-compose
  • python + pyyaml
  • hostname set to hub.crmdr.org
  • static DNS NS records pointing at the host IP for subdomain hub.crmdr.org, e.g.: 
    hub.crmdr.org.      120  IN  NS  ns1.hub.crmdr.org
ns1.hub.crmdr.org.  120  IN  A   212.189.205.193
    Onezone will handle the requests for the domain using the build-in DNS server, which enables subdomain delegation for subject Oneproviders (you can find out more here).

First deployment

  1. Place your auth.config in data/secret/auth.config - see OpenID & SAML for more
  2. Verify that data/configs/overlay.config includes desired and up-to-date config
  3. Run ./onezone.sh start (see onezone.sh)
  4. The installation should happen automatically (batch mode) and might take a while (consult container logs for indication whether the installation was finished)
  5. Visit https://hub.crmdr.org and log in using the credentials admin:EMERGENCY_PASSPHRASE (can be found in data/secret/emergency-passphrase.txt)

Maintaining the deployment

The Onezone docker is configured to restart automatically.

You can use the onezone.sh script to easily start / stop the deployment and for some convenient commands allowing to exec to the container or view the logs.

Regularly back-up the persistence directory: data/persistence.

To upgrade, stop the deployment (./onezone.sh stop), bump the onezone image version in docker-compose.yaml and start the deployment (./onezone.sh start). Make sure to back-up the persistence directory beforehand.

If you modify anything (e.g. onezone image), please commit the changes rather than make them only locally on the host.

More

Please refer to the documentation.