Use Synchronet Git Repository

Synchronet uses Git for its Source Repository (as of August, 2020).

It is highly recommended to clone the Synchronet Git Repository into a directory other than the directory you are/will-be using for your live Synchronet BBS. The following steps clone the repository into the directory /sbbs/repo, so if your Synchronet directory tree was located at /sbbs, then the repository would be cloned to a sub-directory (folder) named repo. This will result in duplicates of several Synchronet directories, e.g.

• /sbbs/exec and /sbbs/repo/exec
• /sbbs/ctrl and /sbbs/repo/ctrl
• /sbbs/text and /sbbs/repo/text

etc., once the BBS is installed, configured, and operational.

To clone the repository to your local system (into a directory named /sbbs/repo) using unauthenticated HTTPS:

$ git clone https://gitlab.synchro.net/sbbs/sbbs.git /sbbs/repo

To clone the repository to your local system using SSH (your public key must be configured for your user account at gitlab.synchro.net):

$ git clone git@gitlab.synchro.net:sbbs/sbbs.git /sbbs/repo

The Synchronet Source Repository is mirrored (e.g. for faster download/cloning) at:

• https://github.com/SynchronetBBS/sbbs
• https://gitlab.com/SynchronetBBS/sbbs

If you do not plan to make significant changes to the contents of the exec and text directories, you can make their later update more seamless (e.g. upon git clone) by either:

1. Setting SCFG->System->Advanced Options->Exec Directory to ../repo/exec/ and Setting SCFG->Nodes->Node 1->Advanced Options->Text Directory to ../repo/text
2. Or (on *nix-like systems) symlinking sbbs/repo/exec to sbbs/exec and the same for text.

This approach is feasible even for sysops that make changes to files in exec and text by using a local branch (i.e. merging in upstream changes from the master branch), but that setup should be pursued only by experienced Git users.

If you're going to make any changes to any files in the repo, you should first create a local branch. To create a local branch and check it out (make it the current branch):

$ git checkout -b <your-awesome-branch-name>

To download the latest changes from the Synchronet repository and integrate (merge) with your changed files, while your branch is checked-out (run git status if you're unsure):

$ git pull
$ git merge master

You attempt to push a set of commits and get the following error:

$ git push
To gitlab.synchro.net:sbbs/sbbs.git
 ! [rejected]            master -> master (non-fast-forward)
error: failed to push some refs to 'git@gitlab.synchro.net:sbbs/sbbs.git'
hint: Updates were rejected because the tip of your current branch is behind
hint: its remote counterpart. Integrate the remote changes (e.g.
hint: 'git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.

To avoid a 'merge commit', do this (assuming you only made one commit before attempting the push):

$ git reset --soft HEAD~1
$ git pull

Then re-add/commit, and push your changes.

If you're being prompted for your gitlab password when pushing changes to gitlab.synchro.net, that's an indicator that you're using https rather than ssh (the default) for the Git communication protocol.

Make the following change to your sbbs/repo/.git/config file:

[remote "origin"]
        url = git@gitlab.synchro.net:sbbs/sbbs

With that change, if your SSH public key is registered with your gitlab.synchro.net user account, git should automatically authenticate for push requests.

• howto index