Skip to content

Installing Helpy using Docker

Jump to bottom Edit New page
hninhninhtun edited this page Sep 16, 2022 · 6 revisions

Docker is an open platform for building, shipping and running distributed applications. It gives programmers, development teams and operations engineers the common toolbox they need to take advantage of the distributed and networked nature of modern applications. See http://www.docker.com/

Prerequisites:

A server with Docker installed (doesn't matter the OS or provider, docker can be installed easily via get.docker.com)

  • Docker compose installed (There's a guide here on how to install compose)
  • Install Git

Installation:

  1. Clone Helpy repository To clone the Helpy repo, run the following command: git clone https://github.com/helpyio/helpy.git

  2. Edit files for your configuration Edit docker/.env file and enter the necessary information and passwords. Edit docker/Caddyfile if you wish to include your website's URL and enable SSL.

NOTE: You can edit docker/run.sh and set DO_NOT_PREPARE to true which will decrease the time it takes the container to start, but could end up causing issues if you ever try to update.

  1. Start the services To start the services, run
docker-compose up -d

Updating:

  1. cd into your Helpy directory

  2. Run git pull

  3. Run docker-compose pull && docker-compose up -d

  4. You're done! Enjoy the latest version of Helpy 😄

NOTE: The services can take a few minutes to start depending on the server you run it on, so be patient.

Add a custom footer
Add a custom sidebar
Clone this wiki locally