Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
install:docker [2021/02/22 15:17] – created hubinstall:docker [2022/09/08 19:42] (current) – misc formatting fixes/changes. tracker1
Line 1: Line 1:
-====== Docker ======+====== Install Synchronet on Docker ======
  
  
-[[http://wiki.synchro.net/|Synchronet]] is built from *[[https://gitlab.synchro.net/main/sbbs|source]]via *[[https://github.com/bbs-io/synchronet-docker|bbs-io/synchronet-docker on github]]*.+**[[https://hub.docker.com/repository/docker/bbsio/synchronet/general|Synchronet on Docker Hub]]** images are built from [[https://gitlab.synchro.net/main/sbbs|source]] via [[https://github.com/bbs-io/synchronet-docker|bbs-io/synchronet-docker on github]].  Images are build for x86_64 (arm builds are currently broken)
  
 ==== Tags ==== ==== Tags ====
  
-  * //:latest// - The latest stable release version (3.18b) +  * '':latest'' - The latest stable release version (3.18b) 
-  * //#////#.##////#.##x// - Major, Minor, Patch options +  * ''#''''#.##''''#.##x'' - Major, Minor, Patch options 
-  * //:nightly// - The latest nightly +  * '':nightly'' - The latest nightly 
-  * //:nightly-YYYYMMDD// - Specific nightly (ex: //nightly-20210222//)+  * '':nightly-YYYYMMDD'' - Specific nightly (ex: ''nightly-20220903'') 
 + 
 +NOTE: ''latest'', ''3'' and ''3.19'' are build from a nightly (2022-09-03) as build outputs were not working as expected in ''3.19b'' release.
  
  
Line 17: Line 19:
  
  
-===== Running =====+===== First Run =====
  
-For your first time running Synchronet (fresh install)you should prepare the directories for volume mounting.+For your first run, you may want to run the Synchronet Configuration Program 
 +(scfgbefore you proceed to start any services.
  
-    sudo mkdir -p /sbbs/backup +    mkdir -p ~/sbbs 
-    sudo mkdir -p /sbbs/ctrl +    cd ~/sbbs 
-    sudo mkdir -p /sbbs/text +    docker run --rm -it -v "$PWD:/sbbs-data" bbsio/synchronet:latest scfg
-    sudo mkdir -p /sbbs/web +
-    sudo mkdir -p /sbbs/data +
-    sudo mkdir -/sbbs/fido +
-    sudo mkdir -/sbbs/xtrn +
-    sudo mkdir -p /sbbs/mods +
-    sudo mkdir -p /sbbs/nodes +
-    sudo chmod a+rwX /sbbs+
  
-If upgrading from a previous runyou should pull the latest release.+This will create your sbbs storage directory inside your profileand run the 
 +synchronet configuration program with that directory connected. This container 
 +is setup so that the data directories are initialized on first run of (''scfg'' or 
 +''sbbs'') if necessary.
  
-    docker pull bbsio/synchronet:latest 
  
 +===== Running =====
  
-From here, you can start sbbs:+The easiest way to get running is with docker-compose.
  
-    docker run -d --restart=unless-stopped \ +    mkdir ~/sbbs 
-      --name sbbs \ +    cd ~/sbbs 
-      -h sbbs \ +    wget -O docker-compose.yml https://raw.githubusercontent.com/bbs-io/synchronet-docker/master/docker-compose.yml 
-      -v /sbbs/backup:/backup +    docker-compose up -d 
-      -v /sbbs/ctrl:/sbbs/ctrl +    sudo chmod -R a+rwX ./*
-      -v /sbbs/text:/sbbs/text +
-      -v /sbbs/web:/sbbs/web +
-      -v /sbbs/data:/sbbs/data +
-      -/sbbs/fido:/sbbs/fido +
-      -/sbbs/xtrn:/sbbs/xtrn +
-      -v /sbbs/mods:/sbbs/mods +
-      -v /sbbs/nodes:/sbbs/nodes +
-      -p 23:23 +
-      -p 80:80 +
-      ...repeat for all service ports... +
-      bbsio/synchronet:latest+
  
 +To shutdown:
  
-===== Shutting Down =====+   docker-compose down
  
 +To get a bash prompt inside the running container:
  
-To shut down and remove an existing instance, such as before running a new version. +    docker exec -it sbbs bash 
- +     
-    docker rm --force sbbs+To run scfg:
  
 +    docker exec -it sbbs scfg
  
 ===== Editing Content ===== ===== Editing Content =====
Line 71: Line 62:
     sudo chmod a+rwX /sbbs     sudo chmod a+rwX /sbbs
  
-or 
- 
-    docker run -i sbbs sbbs-access 
  
 ===== Volumes ===== ===== Volumes =====
  
-In order to better support portability, the following volume mounts are expected Most directories will be populated on first run.+In order to better support portability, you should mount your storage directory to ''/sbbs-data/'' inside the running container. Most directories will be populated on first run.
  
-  * `/backup` location in order to generate/create backup scripts inside the container. +Under your ''/sbbs-data/'' directory, the following directories will be populated.
-    * `/defaults` - updated on first run, or updated versions, will container default directories from `/sbbs/` for reference. +
-  * `/sbbs/ctrl` - note: `text.dat` will be overwritten on updated versions. +
-  * `/sbbs/text` +
-  * `/sbbs/web` - not populated, copy files from `/backup/defaults/web-ecweb4` or `/backup/defaults/web-runemaster` +
-  * `/sbbs/data` +
-  * `/sbbs/fido` +
-  * `/sbbs/xtrn` - external programs, will populate directories that don't exist on first run or update +
-  * `/sbbs/mods` - your customizations, empty by default +
-  * `/sbbs/nodes` - shared nodes directory, not required if a single host is used.+
  
-===== Ports =====+  * ''backup/defaults/'' - will be initialized with the default build for synchronet on first run, or upgrade. 
 +  * ''ctrl/'' - note: ''text.dat'' will be overwritten on updated versions. 
 +  * ''data/'' - Synchronet's default data storage directory, includes file directories. 
 +  * ''text/'' 
 +  * ''web/'' - default populated from ''/backup/defaults/web-ecweb4'' 
 +  * ''data/'' 
 +  * ''fido/'' 
 +  * ''xtrn/'' - external programs, will populate directories that don't exist on first run or update 
 +  * ''mods/'' - your customizations, empty by default 
 +  * ''nodes/node{n}'' - shared nodes directory (mapped to ''/sbbs/node{n}'' internally).
  
 +
 +===== Ports =====
  
 Synchronet is preconfigured for the following services/ports, see `/sbbs/ctrl/sbbs.ini` and `/sbbs/ctrl/services.ini` for additional configuration. Synchronet is preconfigured for the following services/ports, see `/sbbs/ctrl/sbbs.ini` and `/sbbs/ctrl/services.ini` for additional configuration.
  
-  * `80- http +  * ''80'' - http 
-  * `443-  https +  * ''443'' -  https 
-  * `1123- ws-term - used for ftelnet virtual terminal web connections +  * ''1123'' - ws-term - used for ftelnet virtual terminal web connections 
-  *  `11235- wss-term - used for ftelnet virtual terminal web connections +  * ''11235'' - wss-term - used for ftelnet virtual terminal web connections 
-  *  `21-  ftp +  * ''21'' -  ftp 
-  * `22`-  ssh +  * ''22''-  ssh 
-  * `23- telnet +  * ''23'' - telnet 
-  * `513`-  rlogin +  * ''513''-  rlogin 
-  *  `64- petscii 40-column +  * ''64'' - petscii 40-column 
-  *  `128- petscii 128-column +  * ''128'' - petscii 128-column 
-  * `25- smtp-mail +  * ''25'' - smtp-mail 
-  * `587- smtp-submit +  * ''587'' - smtp-submit 
-  * `465- smtp-submit+tls +  * ''465'' - smtp-submit+tls 
-  * `110- pop3 +  * ''110'' - pop3 
-  * `995- pop3+tls +  * ''995'' - pop3+tls 
-  * `119- nntp +  * ''119'' - nntp 
-  * `563- nntps +  * ''563'' - nntps 
-  * `18- message send prot +  * ''18'' - message send prot 
-  * `11- active user svc +  * ''11'' - active user svc 
-  * `17- qotd +  * ''17'' - qotd 
-  * `79- finger +  * ''79'' - finger 
-  * `6667- irc+  * ''6667'' - irc
  
 Other services/ports that may be enabled: Other services/ports that may be enabled:
  
-- `5500- hotline +  * ''5500'' - hotline 
-- `5501- hotline-trans +  * ''5501'' - hotline-trans 
-- `24554- binkp +  * ''24554'' - binkp 
-- `24553- binkps +  * ''24553'' - binkps 
-- `143- imap +  * ''143'' - imap 
-- `993- imap+tls+  * ''993'' - imap+tls
  
  
 ===== See Also ===== ===== See Also =====
   * [[:install:|install index]]   * [[:install:|install index]]
 +  * [[howto:docker|How to Setup Docker on Ubuntu]]
  
 {{tag>}} {{tag>}}
  
install/docker.1614035851.txt · Last modified: 2021/02/22 15:17 by hub
Back to top
CC Attribution 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0