Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions content/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ page_template = "page.html"
# Getting started
The web app is available at [app.sable.moe](https://app.sable.moe/) and gets updated on frequently, as soon as a feature is deemed stable.

Native desktop and mobile builds are still being worked on in [#88](https://github.com/SableClient/Sable/issues/88). For now, use the web app directly, or [install it as a Progressive Web App (PWA) on your phone.](https://www.installpwa.com/from/app.sable.moe)
The latest changes on the `main` branch are available at <https://dev.sable.moe>

Native desktop and mobile apps are available [on GitHub](https://github.com/SableClient/Sable/releases)

# Self-hosting on the web

# Self-hosting
You have a few options for self hosting, you can:
1. Run the prebuilt docker container.
2. Deploy on a site like GitLab Pages. Jae has a [guide here](https://docs.j4.lc/Tutorials/Deploying-Sable-on-GitLab-Pages).
Expand Down
93 changes: 92 additions & 1 deletion content/matrix-guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,95 @@ template = "index.html"
page_template = "page.html"
+++

hi
<!-- hah, easter egg! This page was written by Alexia Starling. -->

> [!TIP]
> This page assumes you know a *little* bit about chat apps in
> general. Which you likely do if you ended up here. Welcome!

Matrix is, at it's core, another chat-app. Similar to Discord, Signal,
WhatsApp or whatever else you might be using.

It has some important differences though, that makes it resistant to
many of the reasons you probably seek refuge here; But let's not get
ahead of ourselves and actually talk about what Matrix *is*.

Matrix is a decentralized approach to messaging. Instead of having
one, single provider, we have multiple! And thanks to the underlying
tech, we can all talk to one another regardless of the provider you
choose.

It's also an *open network*, where the entire text and technical
information on how it works is publicly accessible, and a
collaborative effort. Anyone can create a chat-app using it and is
encouraged to share their efforts, so that others can also implement
eachother's features.

Sable is but one player in the wider ecosystem, there is [many
more](https://matrix.org/ecosystem/clients) out there, including
[server-software](https://matrix.org/ecosystem/servers) for those of
us that wan't to become their own provider (or provide just for
themselves!).

But enough with the sales pitch, let's get to actually hopping on
Matrix.

## Getting Started: For regular users

To get started, you can [Download Sable](/installation) or use it on
the web at <https://app.sable.moe>

You can leave options at their default and just hit `Continue with
Matrix.org` and create an account. Though, it should be stated that
further down in this guide, we list some reasons as to why you might
wanna consider spending a *little* extra time picking out another
provider.

Regardless, you can continue and register, and when you're done you'll
be at an empty screen that looks and feels a bit like Discord!

From here you can:
- Create a room from the sidebar > Home > Create room
- Create a space (more on that later) from the sidebar > [+] > Create
new space
- Join an existing room from the sidebar > Home > Join with Address
- Swap over to Direct Messages with the icon below Home in the sidebar

### Useful words and terminology

- Spaces: A collection of rooms! This can either be for private use,
or for public communities. They have separate permissions from the
rooms inside
- Direct Message: Anything that appears in the Direct Messages tab,
usually one-on-one discussions
- Alias or Address: The human-readable address to a room or space,
usually something like this: `#example:matrix.org`
- Invite: manually inviting a specific user to a room or DM using the
UI; Links to rooms/spaces are *not* called invites by most people
- MXID: Short for "Matrix ID", it's your unique username+provider
combo, like `@bob:matrix.org`

### Why you should consider signing up somewhere other than Matrix.org

Matrix is decentralized, as previously discussed, and this gives it
one major strength: There's no one company or anything else that can
dictate the rules, whether or not your account gets banned, or whether
you can keep talking to your friends.

Though, by principle, this becomes less and less relevant if everyone
is using the same provider. That freedom is lost, because it means a
majority of the users can *still* be screwed over by that large
provider.

To avoid this, all you need to do is sign up on a different server,
one that isn't the default Matrix.org. Not only will you not have to
worry about this hypothetical, but chances are the provider will be
faster because there will be much less people using it at the same
time :)

There is a list of public servers, together with security information
and data about how long they've been operating at
<https://servers.joinmatrix.org>

> [!WARNING]
> Do note: This page is *not* maintained by the Matrix.org Foundation.