Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
install:docker [2021/02/22 15:33] – hubinstall:docker [2022/09/08 19:42] (current) – misc formatting fixes/changes. tracker1
Line 1: Line 1:
-====== Docker ======+====== Install Synchronet on Docker ======
  
  
-**[[https://hub.docker.com/repository/docker/bbsio/synchronet/general|Synchronet on Docker Hub]]** images are 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 15: Line 17:
  
 If you are running Windows, it is recommended that you first install WSL2, then Docker Desktop, configured for WSL2 and doing your volume mounts from inside WSL2 (such as with Ubuntu).  VS Code with WSL Remote extension will make editing much easier to work with.  Note: you can access your WSL2 instances in explorer via `\\wsl$`.  You may want to add your SBBS volume directory to your Quick access shortcuts. If you are running Windows, it is recommended that you first install WSL2, then Docker Desktop, configured for WSL2 and doing your volume mounts from inside WSL2 (such as with Ubuntu).  VS Code with WSL Remote extension will make editing much easier to work with.  Note: you can access your WSL2 instances in explorer via `\\wsl$`.  You may want to add your SBBS volume directory to your Quick access shortcuts.
 +
 +
 +===== First Run =====
 +
 +For your first run, you may want to run the Synchronet Configuration Program
 +(scfg) before you proceed to start any services.
 +
 +    mkdir -p ~/sbbs
 +    cd ~/sbbs
 +    docker run --rm -it -v "$PWD:/sbbs-data" bbsio/synchronet:latest scfg
 +
 +This will create your sbbs storage directory inside your profile, and 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.
 +
  
 ===== Running ===== ===== Running =====
Line 22: Line 40:
     mkdir ~/sbbs     mkdir ~/sbbs
     cd ~/sbbs     cd ~/sbbs
-    wget docker-compose.yml -O https://raw.githubusercontent.com/bbs-io/synchronet-docker/master/docker-compose.yml+    wget -O docker-compose.yml https://raw.githubusercontent.com/bbs-io/synchronet-docker/master/docker-compose.yml
     docker-compose up -d     docker-compose up -d
     sudo chmod -R a+rwX ./*     sudo chmod -R a+rwX ./*
Line 33: Line 51:
  
     docker exec -it sbbs bash     docker exec -it sbbs bash
 +    
 +To run scfg:
  
-To reset file permissions for editing (root by default): +    docker exec -it sbbs scfg
- +
-    sudo chmod -R a+rwX ./* +
  
 ===== Editing Content ===== ===== Editing Content =====
Line 45: 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. 
 + 
 +Under your ''/sbbs-data/'' directory, the following directories will be populated. 
 + 
 +  * ''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).
  
-  * `/backup` - location in order to generate/create backup scripts inside the container. 
-    * `/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 ===== ===== Ports =====
Line 68: Line 85:
 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>}}
  

Trace: