| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| install:nix [2023/01/27 10:27] – Move termcap/terminfo to its own page and reference it here in the See Also section digital man | install:nix [2025/01/17 09:44] (current) – [Errors] Needing LD_LIBRARY_PATH or ld.so.conf is a bug. deuce |
|---|
| ====== UNIX Installation ====== | ====== UNIX Installation ====== |
| |
| You will likely need to build Synchronet from [[dev:source]] code for your Unix/Linux distribution, version, and platform architecture. | Build Synchronet from [[dev:source]] code for your Unix/Linux OS distribution, version, and platform architecture. |
| |
| Before attempting to install/build Synchronet, insure that the [[install:nix:prerequisites]] are installed. | :!: **Before attempting to build Synchronet, insure that the system [[install:nix:prerequisites]] are already installed.** |
| |
| You will to use a *nix terminal and command shell (e.g. sh/bash) to install and configure Synchronet. | You will need to use a *nix terminal and command shell (e.g. sh/bash) to install and configure Synchronet. |
| |
| ===== Run-as User ===== | ===== Run-as User ===== |
| It is recommended that you install Synchronet while logged-in with the user account that Synchronet will be run-as. If you install Synchronet with one user account and then later run with another (non-root) user account, you could encounter permissions errors. | It is recommended that you install Synchronet while logged-in with the user account that Synchronet will be run-as. If you install Synchronet with one user account and then later run with another (non-root) user account, you could encounter permissions errors. |
| |
| **Running the BBS servers/services (''sbbs'') as the ''root'' user is not recommended**. | :!: **Running the BBS servers/services (''sbbs'') as the system's ''root'' user is not recommended**. |
| |
| Use ''adduser'' (or "''sudo adduser''" if necessary) to create the //run-as// user account (e.g. ''sbbs''). | Use ''adduser'' (or "''sudo adduser''" if necessary) to create the //run-as// user account (e.g. ''sbbs''). |
| |
| On Linux, it's very convenient for the run-as user to have ''sudo'' access. To achieve this, as a sudo/root user: | On Linux, it's very convenient for the run-as user to have ''sudo'' access. To achieve this, as a sudo/root user: |
| $ sudo usermod -G sudo sbbs | $ sudo adduser sbbs sudo |
| $ groups sbbs | $ groups sbbs |
| sbbs : sbbs sudo ... | sbbs : sbbs sudo ... |
| Belonging to the ''sudo'' group will allow the you to perform system administration functions while logged-in as the BBS //run-as// user through the use of the ''sudo'' command. | Belonging to the ''sudo'' group will allow you to perform system administration functions while logged-in as the BBS //run-as// user through the use of the ''sudo'' command. |
| |
| Use the ''su'' command to switch the current user to the //run-as// user (the "''-''" specifies to //login// as that user, e.g. setting the cwd to that user's home directory): | Use the ''su'' command to switch the current user to the //run-as// user (the "''-''" specifies to //login// as that user, e.g. setting the cwd to that user's home directory): |
| Choose a build method (using [[dev:Git]] or Tarball)((The Git install method is preferred/recommended)): | Choose a build method (using [[dev:Git]] or Tarball)((The Git install method is preferred/recommended)): |
| |
| ==== Using Git ==== | ==== Git Build Method ==== |
| |
| Quick installation from [[dev:Git]] (requires 100+MB of disk space): | Quick installation from [[dev:Git]] (requires 100+MB of disk space): |
| |
| * ''$ [[install:nix:fetch makefile|wget]] [[https://gitlab.synchro.net/main/sbbs/-/raw/master/install/GNUmakefile]]'' | * ''$ [[install:nix:fetch makefile|wget]] [[https://gitlab.synchro.net/main/sbbs/-/raw/master/install/install-sbbs.mk]]'' |
| |
| To get and build the latest code: | To get and build the latest code: |
| |
| * ''$ [[install:nix:make|make]] install SYMLINK=1'' | * ''$ [[install:nix:make|make]] -f install-sbbs.mk SYMLINK=1'' |
| |
| On Linux, it's normal that the user's password may be prompted for near the end of the build process, as required to invoke the ''sudo setcap'' command to enable low-port-binding capability on the Synchronet ''sbbs'' executable. | On Linux, it's normal that the user's password may be prompted for near the end of the build process, as required to invoke the ''sudo setcap'' command to enable low-port-binding capability on the Synchronet ''sbbs'' executable. |
| If building on a Linux system as a user without ''sudo'' access, pass the ''NOCAP=1'' option to disable this function((there are other methods of enabling low-port binding on Linux systems)): | If building on a Linux system as a user without ''sudo'' access, pass the ''NOCAP=1'' option to disable this function((there are other methods of enabling low-port binding on Linux systems)): |
| |
| * ''$ [[install:nix:make|make]] install SYMLINK=1 NOCAP=1'' | * ''$ [[install:nix:make|make]] -f install-sbbs.mk SYMLINK=1 NOCAP=1'' |
| |
| Or, if you want to build a stable release from Git, specify a valid release [[dev:tags|tag]] on the make command-line (e.g. ''sbbs319b''): | Or, if you want to build a stable release from Git, specify a valid release [[dev:tags|tag]] on the make command-line (e.g. ''sbbs320b''): |
| * ''$ [[install:nix:make|make]] install SYMLINK=1 **TAG=sbbs3xxx**'' | * ''$ [[install:nix:make|make]] -f install-sbbs.mk SYMLINK=1 **TAG=sbbs3xxx**'' |
| * **NOTE**: this does not work with release tags earlier than ''sbbs319b'', use the Tarball install method instead for those. | * **NOTE**: this does not work with release tags earlier than ''sbbs319b'', use the Tarball install method instead for those. |
| |
| * These commands will make and install a //RELEASE// build of the software. To make and install a //DEBUG// build instead, pass ''DEBUG=1'' on the ''make'' command-lines. | * These commands will make and install a //RELEASE// build of the software. To make and install a //DEBUG// build instead, pass ''DEBUG=1'' on the ''make'' command-lines. |
| * We don't support parallel builds (e.g. ''make -j'') - so don't do that. | * We don't support parallel builds (e.g. ''make -j'') - so don't do that. |
| * On //Linux// systems, your user password will be prompted for to execute the ''sudo setcap'' command during install. If this is a problem, you can include ''NOCAP=1'' on the ''make'' command-line to bypass that step. | * Mirrors of the ''install/install-sbbs.mk'' are available at |
| * Mirrors of the ''install/GNUmakefile'' are available at | * [[https://github.com/SynchronetBBS/sbbs/raw/master/install/install-sbbs.mk]] |
| * [[https://github.com/SynchronetBBS/sbbs/raw/master/install/GNUmakefile]] | * [[https://gitlab.com/SynchronetBBS/sbbs/-/raw/master/install/install-sbbs.mk]] |
| * [[https://gitlab.com/SynchronetBBS/sbbs/-/raw/master/install/GNUmakefile]] | |
| |
| |
| lrwxrwxrwx 1 sbbs sbbs 25 Jan 26 21:03 docs -> /home/sbbs/sbbs/repo/docs | lrwxrwxrwx 1 sbbs sbbs 25 Jan 26 21:03 docs -> /home/sbbs/sbbs/repo/docs |
| lrwxrwxrwx 1 sbbs sbbs 25 Jan 26 21:03 exec -> /home/sbbs/sbbs/repo/exec | lrwxrwxrwx 1 sbbs sbbs 25 Jan 26 21:03 exec -> /home/sbbs/sbbs/repo/exec |
| -rw-r--r-- 1 sbbs sbbs 11001 Jan 26 20:51 GNUmakefile | -rw-r--r-- 1 sbbs sbbs 11001 Jan 26 20:51 install-sbbs.mk |
| drwxr-xr-x 1 sbbs sbbs 116 Jan 26 21:07 node1 | drwxr-xr-x 1 sbbs sbbs 116 Jan 26 21:07 node1 |
| drwxr-xr-x 1 sbbs sbbs 48 Jan 26 21:06 node2 | drwxr-xr-x 1 sbbs sbbs 48 Jan 26 21:06 node2 |
| |
| **Notes**: | **Notes**: |
| * You can safely remove the installation ''GNUmakefile'' once successfully installed; it has served its purpose. | * You can safely remove the installation ''install-sbbs.mk'' once successfully installed; it has served its purpose. |
| |
| ==== Tarball ==== | ==== Tarball Build Method ==== |
| Alternatively, if you don't have a working Git client or are low on available disk space, you can use the following steps to install the latest nightly development build: | Alternatively, if you don't have a working Git client or are low on available disk space, you can use the following steps to install the latest nightly development build: |
| |
| - ''$ tar -xzf sbbs_src.tgz'' | - ''$ tar -xzf sbbs_src.tgz'' |
| - ''$ tar -xzf sbbs_run.tgz'' | - ''$ tar -xzf sbbs_run.tgz'' |
| - ''$ echo RELEASE=1 > src/build/localdefs.mk'' | |
| - ''$ cd src/sbbs3'' | - ''$ cd src/sbbs3'' |
| - ''$ SBBSEXEC=/sbbs/exec [[install:nix:make|make]] symlinks''((include the 'setcap' target if you intend to use Linux-capabilities to bind low ports)) | - ''$ SBBSEXEC=/sbbs/exec [[install:nix:make|make]] symlinks''((include the 'setcap' target if you intend to use Linux-capabilities to bind low ports)) |
| |
| If you want to build a stable release, replace the archive filenames above with valid release filenames: | If you want to build a stable release, replace the archive filenames above with valid release filenames: |
| - replace ''sbbs_src.tgz'' with ''ssrc**319b**.tgz'' | - replace ''sbbs_src.tgz'' with ''ssrc**320b**.tgz'' |
| - replace ''sbbs_run.tgz'' with ''srun**319b**.tgz'' | - replace ''sbbs_run.tgz'' with ''srun**320b**.tgz'' |
| |
| ==Using System Libraries== | ==Using System Libraries== |
| error: unknown type name 'wint_t' | error: unknown type name 'wint_t' |
| |
| * The following error indicates the Synchronet libraries (shared objects) are not in your system's library search path or in the directory from which ''sbbs'' was built. Set the ''LD_LIBRARY_PATH'' [[config:env|environment variable]] to point to your Synchronet ''[[dir:exec]]'' directory to resolve: | * The following error indicates the Synchronet libraries (shared objects) are not in your system's library search path or in the directory from which ''sbbs'' was built. You can try setting the ''LD_LIBRARY_PATH'' [[config:env|environment variable]] to point to your Synchronet ''[[dir:exec]]'' directory or add that directory to your ''/etc/ld.so.conf'' file (and run ''ldconfig'') to work around. Please report a bug if this works, as it should never be necessary.: |
| |
| sbbs: error while loading shared libraries: libsbbs.so: cannot open shared object file: No such file or directory | sbbs: error while loading shared libraries: libsbbs.so: cannot open shared object file: No such file or directory |
| get from the devs is "don't do that then". Partial documentation can be found here: [[:install:nix:options]] | get from the devs is "don't do that then". Partial documentation can be found here: [[:install:nix:options]] |
| |
| === Third Party Builds === | === Pre-built Binaries === |
| |
| Some third parties make unsupported tarballs available from their own sites. Using them is not recommended or supported. Whenever possible you should build yourself. | Some parties make pre-built executable binaries available for download. Whenever possible, you should build executables for your platform yourself. |
| |
| ^ OS ^ Platform ^ Provided By ^ Date ^ Archive ^ | ^ OS ^ Architecture ^ Provided By ^ Date ^ Archive ^ |
| | Debian (testing) | amd64 | [[person:digital_man]] | Every morning (PT) | [[ftp://ftp.synchro.net/sbbs_dev.tgz|sbbs_dev.tgz]] [[ftp://ftp.synchro.net/sbbs_run.tgz|sbbs_run.tgz]] | | | Debian Linux | AMD64/x86-64 | [[person:digital_man]] | Every morning (PT) | [[https://vert.synchro.net/Synchronet/sbbs_dev.tgz|sbbs_dev.tgz]] | |
| | | macOS | ARMv8 | [[person:digital_man]] | Every morning (PT) | [[https://vert.synchro.net/Synchronet/sbbs_dev-macos-armv8.tgz|sbbs_dev-macos-armv8.tgz]] | |
| |
| ===== Configuring ===== | ===== Configuring ===== |
| * [[:monitor:gtkmonitor]] | * [[:monitor:gtkmonitor]] |
| * [[:install:nix:Prerequisites]] | * [[:install:nix:Prerequisites]] |
| | * [[:install:nix:mail|Installing Synchronet as your UNIX mail system]] |
| * [[:install:nix:termcaps|Installing ANSI-BBS Terminal Capabilities]] | * [[:install:nix:termcaps|Installing ANSI-BBS Terminal Capabilities]] |
| * [[:howto:freebsd_non-root|How to run sbbs for FreeBSD as a non-root user]] | * [[:howto:freebsd_non-root|How to run sbbs for FreeBSD as a non-root user]] |
