| To build programs, type: |
| $ make |
| Some useful environment variables: |
| CC change C compiler |
| CFLAGS prepend flags to C compiler |
| LDFLAGS prepend flags to linker (e.g. -L <path>) |
| LIBS additional libraries pass to linker |
| To enable to experimental IRC frontend, add '-D ENABLE_IRC_FRONTEND' to |
| CFLAGS, for example: |
| $ CFLAGS="-D ENABLE_IRC_FRONTEND" make |
| |
| To install built programs and manual pages, type: |
| $ make install |
| Some useful environment variables: |
| PREFIX change installing prefix, default /usr |
| LIBEXECDIR default ${PREFIX}/lib/sshout |
| SBINDIR default ${PREFIX}/sbin |
| DATADIR default ${PREFIX}/share |
| MANDIR default ${DATADIR}/man |
| |
| Some additional steps after 'make install' are needed to get this program |
| work: |
| Add a local user account, with name 'sshout' and shell set to the path of |
| installed sshoutd program; there is an example of suitable passwd(5) line: |
| sshout:*:115:115:Secure Shout Host Oriented Unified Talk:/var/lib/sshout:/usr/lib/sshout/sshoutd |
| This user account must be allowed to log in with SSH public key |
| authentication. |
| This program is currently assuming the AuthorizedKeysFile option in |
| sshd_config(5) is left default, or contains '.ssh/authorized_keys'; otherwise |
| the authentication won't work. |
| Create a service so sshoutd can be started automatically; the service must be |
| started under the sshout user, instead of root. For systemd based systems, |
| you can use the systemd service file provided in 'deploy' directory, by running: |
| # cp deploy/systemd/sshout.service /etc/systemd/system/ |
| And of course you need a working SSH server installed; currently only OpenSSH |
| server is supported. |
| |
| The CLI frontend requiring some addional programs for some features to work: |
| '/pasteimage <user>' requires xclip(1) be available in PATH; |
| '/showhtml color|plain' requires elinks(1) version 0.12 or later be available in PATH. |