Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Whether you want to install Myne for development purposes or spin up your own instance as a user, a few options are available.

Docker

For a list of available image tags and full description, go to Docker Hub.

Simple Docker command:

docker run -it -d \
  -p 2020:2020 \
  -e "MYNE_URL=<url> \
  -e "MYNE_NONCE=<nonce>" \
  -e "MYNE_ADMIN_KEY=<admin_key>" \
  --volume=./data_admin:/myne/data_admin \
  --volume=./data_users:/myne/data_users \
  --name myne-core \
  myne/core:latest

Or with Docker Compose:

# docker-compose.yml
myne-core:
    image: myne-core:latest
    container_name: myne-core
    ports:
      - "2020:2020"
    environment:
      - MYNE_URL=<url>
      - MYNE_NONCE=<nonce>
      - MYNE_ADMIN_KEY=<admin_key>
    volumes:
      - ./data_admin:/myne/data_admin
      - ./data_users:/myne/data_users

Environment variables explanation:

  • MYNE_URL: URL where your Myne instance is accessible from the internet (or http://localhost:2020 for development)
  • MYNE_NONCE: Secret Nonce for encryption, MUST be 12 characters long
  • MYNE_ADMIN_KEY: Secret Admin Key for encryption, MUST be 32 characters long
  • MYNE_SMTP_SERVER: SMTP server address that will be used to send e-mails
  • MYNE_SMTP_USER: SMTP server user
  • MYNE_SMTP_PASSWORD: SMTP server password
  • MYNE_SIGNUP_CODES:

Helm

Coming soon