Skip to content

Setup

With Terminal

This is the latest bleeding edge version of fosscord-server, which may have bugs.

Requirements

  • NodeJS v16+
  • Python 3
  • (Only on Linux) gcc and g++ | Packaged with build-essential on Debian/Ubuntu and base-devel on Arch
  • (Only on Windows) Visual Studio with the C++ package

Make sure python can be executed and is a correct version by just running python -V

Setup

Open a shell/terminal and execute these commands:

git clone https://github.com/fosscord/fosscord-server
cd fosscord-server
npm run setup
npm run start:bundle

You can now access Fosscord on http://localhost:3001

Updating

To update Fosscord, execute these commands:

This reverts any edited files

git reset --hard HEAD
git pull
npm run setup
npm run start:bundle

With Docker

Not Supported Currently

Avoid using Docker build until further notice. The current build is faulty and will not build correctly. Instead, install using the terminal in the section "With Terminal".

Optionally, if you want to use Docker:

git clone https://github.com/fosscord/fosscord-server
cd fosscord-server
docker-compose up -d

You can now access Fosscord on http://localhost:3001