Sharkord
Introduction

Quick Start

Download and run Sharkord in a couple of minutes.

Alpha software

Sharkord is in alpha. Expect bugs, incomplete features, and breaking changes.

Sharkord ships as a single binary that contains both the server and the web client. There is nothing else to install.

Rather watch than read?

How To Deploy Sharkord In 1 Minute sets up the recommended deployment, Docker with Caddy for HTTPS, start to finish.

  1. Download the latest release for your platform from GitHub Releases, or use the Docker image.
  2. Run it: Linux, Windows, macOS.
  3. Open http://localhost:4991 in your browser and create your account.

If the server runs on another machine, replace localhost with its IP address or domain.

First Launch

The first run creates the data directory, writes a default config.ini, and prints an access token to the console:

🚨🚨 I M P O R T A N T 🚨🚨
────────────────────────────────────────────────────
This server has been started for the first time.
Please save this access token somewhere safe, as it will not be shown again and there is no way to recover it.
The access token below is used to gain admin privileges. Anyone with this token can take over the server.

Copy it somewhere safe. It is shown once, it cannot be recovered, and anyone who has it can claim ownership of your server. See Gain Owner Permissions for how to use it.

Next Steps

No server yet?

Sharkord is happy on a small VPS. We host on netcup, whose root servers start at a few euros a month and include enough bandwidth for voice.

netcup: webhosting, domains, vServer and root servers

Referral link. It costs you nothing extra and helps pay for Sharkord's infrastructure. Thank you for your support!

On this page