diff --git a/doc/DOCKER_setup.md b/doc/DOCKER_setup.md index 2e1313e..3d91223 100644 --- a/doc/DOCKER_setup.md +++ b/doc/DOCKER_setup.md @@ -98,6 +98,8 @@ Most options provided in the configuration files can be later modified. New valu For MacOS, see this detailed [installation guide](./DOCKER_mac_setup.MD). +For Synology, see this detailed [installation guide](./DOCKER_synology_setup.md). + This procedure allows to install a new Dojo from scratch. * Install [Docker and Docker Compose](https://docs.docker.com/compose/install/) on the host machine and check that your installation is working. diff --git a/doc/DOCKER_synology_setup.md b/doc/DOCKER_synology_setup.md new file mode 100644 index 0000000..3f32296 --- /dev/null +++ b/doc/DOCKER_synology_setup.md @@ -0,0 +1,57 @@ +# Installation of Dojo on Synology + +This will install Dojo on your Synology hardware. + + + +## Table of Content ## +- [Requirements](#requirements) +- [Install procedure](#install) + + + + + +## Requirements ## + +* Synology hardware connected 24/7 to internet +* Disk: 500GB (minimal) / 1TB (recommended) +* RAM: 4GB (minimal) + + + +## Install procedure + +- Connect to Synology web ui as administrator +- Open `Package center`, search for `Docker`, click `Install`. +![](./static/synology_docker-package.png) +- Open SSH terminal to your Synology +- Follow `first-time install procedure` in [DOCKER_setup.md](DOCKER_setup.md#install), but skip the first two steps: +``` + * Install Docker and Docker Compose on the host machine and check that your installation is working. + * Install Tor Browser on the host machine. +``` +You can use `/volume1/dojo` as ``. +- Install will complete with the following warnings, which you can safely ignore: +``` +Attaching to nginx, nodejs, bitcoind, tor, db +nginx | WARNING: no logs are available with the 'db' log driver +nodejs | WARNING: no logs are available with the 'db' log driver +bitcoind | WARNING: no logs are available with the 'db' log driver +tor | WARNING: no logs are available with the 'db' log driver +db | WARNING: no logs are available with the 'db' log driver +``` +![](./static/synology_install_complete.png) + +## Dojo status & logs +- Connect to Synology web ui as administrator +- Open `Docker`, then `Container`. + ![](./static/synology_containers.png) + +- You will see the following containers running: + * bitcoind + * db + * nginx + * nodejs + * tor +- Select a container (ie `bitcoind`), click `Detail`, `Log` to see container's logs in real time diff --git a/doc/static/synology_containers.png b/doc/static/synology_containers.png new file mode 100644 index 0000000..095fffa Binary files /dev/null and b/doc/static/synology_containers.png differ diff --git a/doc/static/synology_docker-package.png b/doc/static/synology_docker-package.png new file mode 100644 index 0000000..d7bad09 Binary files /dev/null and b/doc/static/synology_docker-package.png differ diff --git a/doc/static/synology_install_complete.png b/doc/static/synology_install_complete.png new file mode 100644 index 0000000..0a17bd9 Binary files /dev/null and b/doc/static/synology_install_complete.png differ