Skip to content

How To: Run Orcpub on Ubuntu 18.04 with Docker and Nginx

Zotz edited this page Feb 27, 2021 · 1 revision

Update Ubuntu 18.04

Update Ubuntu by doing:

sudo apt-get update && apt-get upgrade

Install git.

sudo apt-get install git

Install Docker:

sudo apt install apt-transport-https ca-certificates curl software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu bionic stable"
sudo apt update
sudo apt install docker-ce

Docker should now be installed, the daemon started, and the process enabled to start on boot. Check that it's running:

sudo systemctl status docker

The output should be similar to the following, showing that the service is active and running:

Output

       Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)
       Active: active (running) since Thu 2018-07-05 15:08:39 UTC; 2min 55s ago
       Docs: https://docs.docker.com
    Main PID: 10096 (dockerd)
        Tasks: 16
       CGroup: /system.slice/docker.service
               ├─10096 /usr/bin/dockerd -H fd://
               └─10113 docker-containerd --config /var/run/docker/containerd/containerd.toml

Next, install Docker Compose You can check the latest release version here:

https://github.com/docker/compose/releases

sudo curl -L https://github.com/docker/compose/releases/download/1.28.5/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose`

Next we'll set the permissions:

sudo chmod +x /usr/local/bin/docker-compose

Then we'll verify that the installation was successful by checking the version:

docker-compose --version

This will print out the version we installed:

Output

docker-compose version 1.28.5, build xxxx

Install OrcPub

cd ~/

git clone https://github.com/Orcpub/orcpub.git

This will copy the orcpub repo from Github down to your home/orcpub dir Now edit docker-compose.yaml and change settings:

nano docker-compose.yaml

Change:

EMAIL_ACCESS_KEY: ''  
EMAIL_SECRET_KEY: ''  
EMAIL_SERVER_PORT: 587  
# Email address to send errors to  
EMAIL_ERRORS_TO: ''

To your email server. In this example we will use gmail to send our emails. (Do not use this enter your own)

EMAIL_ACCESS_KEY: '<your full gmail@gmail.com>'  
EMAIL_SECRET_KEY: '<yourpassword>'  
EMAIL_SERVER_PORT: 587  
# Email address to send errors to  
EMAIL_ERRORS_TO: '<email address to end errors to>  - or just leave blank'

Generate Certificates:

./deploy/snakeoil.sh

(and or replace the ones under deploy with your real ones, file names can be found in the deploy/nginx.conf)

Start the docker:

docker-compose up --build

At this point you will see a lot of text scrolling by, if successful it will end with:

[main] INFO org.eclipse.jetty.server.ServerConnector - Started ServerConnector@1082883b{HTTP/1.1,[http/1.1, h2c, h2c-17, h2c-16, h2c-15, h2c-14]}{0.0.0.0}
[main] INFO org.eclipse.jetty.server.Server - Started @12505ms

Hit your ip address in your browser https://localhost or http://localhost and you should get the orcpub page.