It takes about 2 minutes to get up and running with Noteworthy. Out of the box, you get a federation ready Matrix home server and a suite of privacy focused self-hosted applications.

Noteworthy is a collection network meta-protocols and reference implementations that enable collaborative personal overlay networks by building atop the decentralized Matrix messaging protocol. Here's a good overview of Matrix if you're not familiar. Over time, Noteworthy hopes to evolve into a viable alternative to traditional cloud-based online services such as AWS and Google.

By default, when installing Noteworthy, your deployment will expose a federation enabled Matrix home server at matrix.yourdomain.com via an overlay link between your host and the invite-only Decentralabs Hub. Reach out to us via our Matrix channel or via email to request an invite.

or Run your own Hub

You can setup your own Hub with a single invocation of the notectl command-line utility. All you need is a publicly accessible host (such as a DigitalOcean droplet or EC2 instance) with Docker installed. You can also run your Hub at home on any Windows, macOS or Linux host with Docker installed. You can find the instructions for deploying your own Noteworthy hub here.

The command-line interface

Noteworthy's primary user interface is a command-line utility. We've spent a considerable amount of effort in making sure it is well documented.

Here's the output of: notectl --help.

Noteworthy is plugin powered and has a ton of neat stuff just below the surface.

Install Noteworthy

First, make sure Docker is installed.

Copy and paste the Bash command below to install the notectl command-line utility.

bash <(curl -s https://get.noteworthy.im)
This command creates a bash alias notectl that wraps invocations of the command-line utility via the decentralabs/noteworthy:taproot-beta docker container.

Then, run the following command to kickstart the installation process:

notectl install 

You'll be prompted to enter an invite code and a domain name. You can claim a free noteworthy.im subdomain by typing mycoolsubdomain.noteworthy.im (where mycoolsubdomain is something that hasn't already been claimed) OR you can point matrix.mycoolsubdomain.yourdomain.com and mycoolsobdomain.yourdomain.com as CNAMEs to hub.noteworthy.im if you want to bring your own domain.

Thats it! It's that easy to get started with Noteworthy.

After completing the installation process navigate to:

https://matrix.<YOURDOMAIN>.noteworthy.im

and login to Element with the username and password you created during the installation process.

Check out the Matrix FAQ and be sure to drop by #noteworthy:tincan.community to say hi to the Noteworthy community.