gourami

[UNMAINTAINED] Activitypub server in Rust
Log | Files | Refs | README | LICENSE

commit 120f435279f48820eb44790228f40d6037923766
parent 3b9677179fbf2dab6f68ec684ee2ec62d77b9295
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Fri, 22 May 2020 10:50:22 -0500

Remove user guide

Diffstat:
MREADME.md | 4+---
Mdocs/ADMIN_GUIDE.md | 3---
Ddocs/USER_GUIDE.md | 29-----------------------------
Mtemplates/server_info.html | 2+-
4 files changed, 2 insertions(+), 36 deletions(-)

diff --git a/README.md b/README.md @@ -1,4 +1,4 @@ -# 🐟gourami +#🐟gourami ![Build and Test](https://github.com/alexwennerberg/gourami/workflows/Build%20and%20Test/badge.svg) An intentionally small, ultra-lightweight ActivityPub social network. See a live public demo at https://dev.gourami.social/ and [reach out to me](mailto:alex@alexwennerberg.com) if you want an invite so you can try it out. @@ -47,8 +47,6 @@ To create a user account: * Go to `http://localhost:3030/register?key=123` * Create an account and log in -See the [user guide](docs/USER_GUIDE.md) for information on usage. - ## Deployment **Gourami is in alpha / development stage.** diff --git a/docs/ADMIN_GUIDE.md b/docs/ADMIN_GUIDE.md @@ -27,9 +27,6 @@ Gourami doesn't implement unfollows yet, so you'll have to directly modify the d Gourami is built for small deployments -- I have not tested it or designed it for larger implementations. This gives users a lot more flexibility, but requires more trust on your end. For example, a user may be easily able to spam the timeline, spam everyone's notifications, DOS the server, etc, so as an admin you should only allow people on your instance that you trust. You will also find that the quality of the shared timelines will begin to degrade after too many users. If you're still interested in attempting a larger Gourami deployment, I won't stop you, but beware that you're in uncharted territory. -I'm not big into formal rules or codes of context, but if you feel like that's important for your server, you may want to put it in your server message. - - ## Configuration // TODO diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md @@ -1,29 +0,0 @@ -(WIP -- it doesnt actually work like this yet) - -# User Guide - -You will get a notification when someone tags your username in a post or if they reply to your post. - -## Creating a note - -Enter your text in the note box, then click create note. The first post that you tag (via 📝X or >>X, where X is the post number) will be considered a post(s) you're replying to. - -For every local post or user that you tag in a note (using @), that user will receive a notification. - -HTML tags will be stripped from your note input, except for p, br, and span. - -(write about how remote notes are handled) - -## Audiences - -Whenever a user creates a note, that note is visible to all the users on this server, which can be seen on the "local" timeline". - -Gourami has a feature called the "neighbhorhood", which allows one Gourami server to communicate with other social media services. - -The Neighbhorhood timeline consists of all other [ActivityPub](http://activitypub.rocks/) services. If you're not familiar with ActivityPub, it's a shared language that allows different social media applications to communicate with each other. This means that two services that both implement ActivityPub (such as Gourami and [Mastodon](https://joinmastodon.org/) should be able to communicate with each other. In practice, there may be differences between each individual ActivityPub services, - -A note on permissions -- - -While local-only posts are private, a neighborhood post WILL be sent to other servers. Only add servers to your neighborhood that you trust! - -todo -- explain more diff --git a/templates/server_info.html b/templates/server_info.html @@ -1,7 +1,7 @@ {% extends "base.html" %} {% block content %} <div class="text-block padded"> - Welcome to Gourami, an intentionally small, minimalist, invite-only <a href="https://activitypub.rocks/">ActivityPub</a>-based social network. See the <a href="https://github.com/alexwennerberg/gourami/blob/master/docs/USER_GUIDE.md">user guide</a> for more info or look at the <a href="https://github.com/alexwennerberg/gourami">project page</a>! This server can connect with other Gourami servers or other services that implement ActivityPub through the neighborhood. Right now, we are linked with the following actors: + Welcome to Gourami, an intentionally small, minimalist, invite-only <a href="https://activitypub.rocks/">ActivityPub</a>-based social network. See the <a href="https://github.com/alexwennerberg/gourami">project page</a> for more info! This server can connect with other Gourami servers or other services that implement ActivityPub through the neighborhood. Be aware that any post that you share with the neibhorhood is potentially public, and won't be deleted from servers it's shared with if you delete it, so be careful! Right now, we are linked with the following actors: <br> <table> {% for server in server_mutuals %}