From 7f45c3e33965b1d8d607fabb2810c584419a6847 Mon Sep 17 00:00:00 2001 From: Mike Dilger Date: Wed, 21 Feb 2024 11:52:35 +1300 Subject: [PATCH] doc: Note about deploying on linux --- docs/DEPLOYING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/DEPLOYING.md b/docs/DEPLOYING.md index 8e94d99..c19ded4 100644 --- a/docs/DEPLOYING.md +++ b/docs/DEPLOYING.md @@ -8,6 +8,15 @@ Generally these are servers in data centres, but you might be able to make a por to the Internet on a home machine if your ISP doesn't use CGNAT and you know how to configure your firewall/router for this. We leave this up to you. +## Operating System + +Chorus was developed on and for linux. It might work on other operating systems, but I +won't spend any time getting it working on non-linux systems. + +In particular, I wrote [mmap-append](https://github.com/mikedilger/mmap-append) to use +linux specific mmap functionality. Ashkan Kiani came later and generalized the code but +I haven't tried it elsewhere and so I can't vouch for it elsewhere. + ## Deploying the files You'll want to create a `chorus` user. Here is an example for debian based systems: