diff options
| author | 2021-07-23 10:36:28 +0200 | |
|---|---|---|
| committer | 2021-07-23 10:36:28 +0200 | |
| commit | 05e9af089c3041fa162e4dca3b1c5906496e8e90 (patch) | |
| tree | 6972d56a2ab5b5216ba7ec7c951605a775ac1c18 /docs | |
| parent | lil webfingy fix (#106) (diff) | |
| download | gotosocial-05e9af089c3041fa162e4dca3b1c5906496e8e90.tar.xz | |
Oidc (#109)
* add oidc config
* inching forward with oidc idp
* lil webfingy fix
* bit more progress
* further oidc
* oidc now working
* document dex config
* replace broken images
* add additional credits
* tiny doc update
* update
* add oidc config
* inching forward with oidc idp
* bit more progress
* further oidc
* oidc now working
* document dex config
* replace broken images
* add additional credits
* tiny doc update
* update
* document
* docs + comments
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 20 | ||||
| -rw-r--r-- | docs/conf.py | 52 | ||||
| -rw-r--r-- | docs/configuration/basics.md | 1 | ||||
| -rw-r--r-- | docs/configuration/general.md | 1 | ||||
| -rw-r--r-- | docs/configuration/oidc.md | 164 | ||||
| -rw-r--r-- | docs/environment.yml | 49 | ||||
| -rw-r--r-- | docs/index.md | 57 | ||||
| -rw-r--r-- | docs/index.rst | 28 | ||||
| -rw-r--r-- | docs/installation_guide/docker.md | 3 | ||||
| -rw-r--r-- | docs/installation_guide/license.md | 669 | ||||
| -rw-r--r-- | docs/make.bat | 35 | ||||
| -rw-r--r-- | docs/pages/about/about.rst | 42 | ||||
| -rw-r--r-- | docs/pages/about/index.rst | 9 | ||||
| -rw-r--r-- | docs/pages/api/activitypub.rst | 4 | ||||
| -rw-r--r-- | docs/pages/api/client.rst | 4 | ||||
| -rw-r--r-- | docs/pages/api/index.rst | 13 | ||||
| -rw-r--r-- | docs/pages/api/internal.rst | 4 | ||||
| -rw-r--r-- | docs/pages/design/federation.rst | 6 | ||||
| -rw-r--r-- | docs/pages/design/index.rst | 10 | ||||
| -rw-r--r-- | docs/pages/design/safety_features.rst | 4 | 
20 files changed, 895 insertions, 280 deletions
diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index d4bb2cbb9..000000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS    ?= -SPHINXBUILD   ?= sphinx-build -SOURCEDIR     = . -BUILDDIR      = _build - -# Put it first so that "make" without argument is like "make help". -help: -	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile -	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 6881614d4..000000000 --- a/docs/conf.py +++ /dev/null @@ -1,52 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -import sphinx_rtd_theme - -# -- Project information ----------------------------------------------------- - -project = 'GoToSocial' -copyright = '2021, GoToSocial Authors' -author = 'GoToSocial Authors' - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ -    "sphinx_rtd_theme" -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages.  See the documentation for -# a list of builtin themes. -# -html_theme = "sphinx_rtd_theme" - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] diff --git a/docs/configuration/basics.md b/docs/configuration/basics.md new file mode 100644 index 000000000..a67dacc2f --- /dev/null +++ b/docs/configuration/basics.md @@ -0,0 +1 @@ +# How to Manage Configuration diff --git a/docs/configuration/general.md b/docs/configuration/general.md new file mode 100644 index 000000000..23d342b49 --- /dev/null +++ b/docs/configuration/general.md @@ -0,0 +1 @@ +# General diff --git a/docs/configuration/oidc.md b/docs/configuration/oidc.md new file mode 100644 index 000000000..6c6bbe94b --- /dev/null +++ b/docs/configuration/oidc.md @@ -0,0 +1,164 @@ +# OpenID Connect (OIDC) + +GoToSocial supports [OpenID Connect](https://openid.net/connect/), which is an identification protocol built on top of [OAuth 2.0](https://oauth.net/2/), an industry standard protocol for authorization. + +This means that you can connect GoToSocial to an external OIDC provider like [Gitlab](https://docs.gitlab.com/ee/integration/openid_connect_provider.html), [Google](https://cloud.google.com/identity-platform/docs/web/oidc), [Keycloak](https://www.keycloak.org/), or [Dex](https://dexidp.io/) and allow users to sign in to GoToSocial using their credentials for that provider. + +This is very convenient in the following cases: + +- You're running multiple services on a platform (Matrix, Peertube, GoToSocial), and you want users to be able to use the same sign in page for all of them. +- You want to delegate management of users, accounts, passwords etc. to an external service to make admin easier for yourself. +- You already have a lot of users in an external system and you don't want to have to recreate them all in GoToSocial manually. + +## Settings + +GoToSocial exposes the following configuration settings for OIDC, shown below with their default values. + +```yaml +####################### +##### OIDC CONFIG ##### +####################### + +# Config for authentication with an external OIDC provider (Dex, Google, Auth0, etc). +oidc: + +  # Bool. Enable authentication with external OIDC provider. If set to true, then +  # the other OIDC options must be set as well. If this is set to false, then the standard +  # internal oauth flow will be used, where users sign in to GtS with username/password. +  # Options: [true, false] +  # Default: false +  enabled: false + +  # String. Name of the oidc idp (identity provider). This will be shown to users when +  # they log in. +  # Examples: ["Google", "Dex", "Auth0"] +  # Default: "" +  idpName: "" + +  # Bool. Skip the normal verification flow of tokens returned from the OIDC provider, ie., +  # don't check the expiry or signature. This should only be used in debugging or testing, +  # never ever in a production environment as it's extremely unsafe! +  # Options: [true, false] +  # Default: false +  skipVerification: false + +  # String. The OIDC issuer URI. This is where GtS will redirect users to for login. +  # Typically this will look like a standard web URL. +  # Examples: ["https://auth.example.org", "https://example.org/auth"] +  # Default: "" +  issuer: "" + +  # String. The ID for this client as registered with the OIDC provider. +  # Examples: ["some-client-id", "fda3772a-ad35-41c9-9a59-f1943ad18f54"] +  # Default: "" +  clientID: "" + +  # String. The secret for this client as registered with the OIDC provider. +  # Examples: ["super-secret-business", "79379cf5-8057-426d-bb83-af504d98a7b0"] +  # Default: "" +  clientSecret: "" + +  # Array of string. Scopes to request from the OIDC provider. The returned values will be used to +  # populate users created in GtS as a result of the authentication flow. 'openid' and 'email' are required. +  # 'profile' is used to extract a username for the newly created user. +  # 'groups' is optional and can be used to determine if a user is an admin (if they're in the group 'admin' or 'admins'). +  # Examples: See eg., https://auth0.com/docs/scopes/openid-connect-scopes +  # Default: ["openid", "email", "profile", "groups"] +  scopes: +    - "openid" +    - "email" +    - "profile" +    - "groups" +``` + +## Behavior + +When OIDC is enabled on GoToSocial, the default sign-in page redirects automatically to the sign-in page for the OIDC provider. + +This means that OIDC essentially *replaces* the normal GtS email/password sign-in flow. + +When a user logs in through OIDC, GoToSocial will request that user's preferred email address and username from the OIDC provider. It will then use the returned email address to either: + +*If the email address is already associated with a user/account*: sign the requester in as that user/account. + +Or: + +*If the email address is not yet associated with a user/account*: create a new user and account with the returned credentials, and sign the requester in as that user/account. + +In other words, GoToSocial completely delegates sign-in authority to the OIDC provider, and trusts whatever credentials it returns. + +### Username conflicts + +In some cases, such as when a server has been switched to use OIDC after already using default settings for a while, there may be an overlap between usernames returned from OIDC, and usernames that already existed in the database. + +For example, let's say that someone with username `gordonbrownfan` and email address `gordon_is_best@example.org` has an account on a GtS instance that uses the default sign-in flow. + +That GtS instance then switches to using OIDC login. However, in the OIDC's storage there's also a user with username `gordonbrownfan`. If this user has the email address `gordon_is_best@example.org`, then GoToSocial will assume that the two users are the same and just log `gordonbrownfan` in as though nothing had changed. No problem! + +However, if the user in the OIDC storage has a different email address, GoToSocial will try to create a new user and account for this person. + +Since the username `gordonbrownfan` is already taken, GoToSocial will try `gordonbrownfan1`. If this is also taken, it will try `gordonbrownfan2`, and so on, until it finds a username that's not yet taken. It will then sign the requester in as that user/account, distinct from the original `gordonbrownfan`. + +### Malformed usernames + +A username returned from an OIDC provider might not always fit the pattern of what GoToSocial accepts as a valid username, ie., lower-case letters, numbers, and underscores. In this case, GoToSocial will do its best to parse the returned username into something that fits the pattern. + +For example, say that an OIDC provider returns the username `Marx Is Great` for a sign in, which doesn't fit the pattern because it contains upper-case letters and spaces. + +In this case, GtS will convert it into `marx_is_great` by applying the following rules: + +1. Trim any leading or trailing whitespace. +2. Convert all letters to lowercase. +3. Replace spaces with underscores. + +Unfortunately, at this point GoToSocial doesn't know how to handle returned usernames containing special characters such as `@` or `%`, so these will return an error. + +### Group membership + +Most OIDC providers allow for the concept of groups and group memberships in returned claims. GoToSocial can use group membership to determine whether or not a user returned from an OIDC flow should be created as an admin account or not. + +If the returned OIDC groups information for a user contains membership of the groups `admin` or `admins`, then that user will be created/signed in as though they are an admin. + +## Provider Examples + +### Dex + +[Dex](https://dexidp.io/) is an open-source OIDC Provider that you can host yourself. The procedure for installing Dex is out of scope for this documentation, but you can check out the Dex docs [here](https://dexidp.io/docs/). + +Dex is great because it's also written in Go, like GoToSocial, which means it's small and fast and works well on lower-powered systems. + +To configure Dex and GoToSocial to work together, create the following client under the `staticClients` section of your Dex config: + +```yaml +staticClients: +  - id: 'gotosocial_client' +    redirectURIs: +      - 'https://gotosocial.example.org/auth/callback' +    name: 'GoToSocial' +    secret: 'some-client-secret' +``` + +Make sure to replace `gotosocial_client` with your desired client ID, and `secret` with a reasonably long and secure secret (a UUID for example). You should also replace `gotosocial.example.org` with the `host` of your GtS instance, but leave `/auth/callback` in place. + +Now, edit the `oidc` section of your GoToSocial config.yaml as follows: + +```yaml +oidc: +  enabled: true +  idpName: "Dex" +  skipVerification: false +  issuer: "https://auth.example.org" +  clientID: "gotosocial_client" +  clientSecret: "some-client-secret" +  scopes: +    - "openid" +    - "email" +    - "profile" +    - "groups" +``` + +Make sure to replace the `issuer` variable with whatever your Dex issuer is set to. This should be the exact URI at which your Dex instance can be reached. + +Now, restart both GoToSocial and Dex so that the new settings are in place. + +When you next go to log in to GtS, you should be redirected to the sign in page for Dex. On a successful sign in, you'll be directed back to GoToSocial. diff --git a/docs/environment.yml b/docs/environment.yml deleted file mode 100644 index bcb03138e..000000000 --- a/docs/environment.yml +++ /dev/null @@ -1,49 +0,0 @@ -name: gotosocial-docs -channels: -  - defaults -dependencies: -  - _libgcc_mutex=0.1=main -  - ca-certificates=2021.1.19=h06a4308_0 -  - certifi=2020.12.5=py39h06a4308_0 -  - ld_impl_linux-64=2.33.1=h53a641e_7 -  - libedit=3.1.20191231=h14c3975_1 -  - libffi=3.3=he6710b0_2 -  - libgcc-ng=9.1.0=hdf63c60_0 -  - libstdcxx-ng=9.1.0=hdf63c60_0 -  - ncurses=6.2=he6710b0_1 -  - openssl=1.1.1j=h27cfd23_0 -  - pip=21.0.1=py39h06a4308_0 -  - python=3.9.1=hdb3f193_2 -  - readline=8.1=h27cfd23_0 -  - setuptools=52.0.0=py39h06a4308_0 -  - sqlite=3.33.0=h62c20be_0 -  - tk=8.6.10=hbc83047_0 -  - tzdata=2020f=h52ac0ba_0 -  - wheel=0.36.2=pyhd3eb1b0_0 -  - xz=5.2.5=h7b6447c_0 -  - zlib=1.2.11=h7b6447c_3 -  - pip: -    - alabaster==0.7.12 -    - babel==2.9.0 -    - chardet==4.0.0 -    - docutils==0.16 -    - idna==2.10 -    - imagesize==1.2.0 -    - jinja2==2.11.3 -    - markupsafe==1.1.1 -    - packaging==20.9 -    - pygments==2.8.0 -    - pyparsing==2.4.7 -    - pytz==2021.1 -    - requests==2.25.1 -    - snowballstemmer==2.1.0 -    - sphinx==3.5.1 -    - sphinx-rtd-theme==0.5.1 -    - sphinxcontrib-applehelp==1.0.2 -    - sphinxcontrib-devhelp==1.0.2 -    - sphinxcontrib-htmlhelp==1.0.3 -    - sphinxcontrib-jsmath==1.0.1 -    - sphinxcontrib-qthelp==1.0.3 -    - sphinxcontrib-serializinghtml==1.1.4 -    - urllib3==1.26.3 - diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..f1630f082 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,57 @@ +# What is GoToSocial? + +GoToSocial provides a lightweight, customizable, and safety-focused entryway into the [Fediverse](https://en.wikipedia.org/wiki/Fediverse), and is comparable to (but distinct from) existing projects such as [Mastodon](https://joinmastodon.org/), [Pleroma](https://pleroma.social/), [Friendica](https://friendica.net), and [PixelFed](https://pixelfed.org/). + +With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles, without being tracked or advertised to. + +## Federation + +Because GoToSocial uses the [ActivityPub](https://activitypub.rocks/) protocol, you can Keep in touch not only with people on your home server, but with people all over the [Fediverse](https://en.wikipedia.org/wiki/Fediverse), seamlessly! + +## Mastodon API compatible + +Full support for modern, elegant apps like [Tusky](https://tusky.app/) and [Pinafore](https://pinafore.social/). + +## Granular post settings + +You should be able to choose how your posts can be interacted with: + +* Local-only posts. +* Rebloggable/boostable toggle. +* 'Likeable' toggle. +* 'Replyable' toggle. + +## Easy customizability for admins + +* Adjustable post length. +* Media upload size settings. + +## LetsEncrypt + + Built-in, automatic support for secure HTTPS with [LetsEncrypt](https://letsencrypt.org/). + +## Light footprint and good performance + +Plays nice with lower-powered machines like Raspberry Pi, old laptops and tiny VPSes. + +## Easy to deploy + +No external dependencies apart from a database. Just download the binary + assets (or Docker container), and run. + +## HTTP signature authentication + +Protect your data. + +## User Safety + +Strict privacy enforcement for posts and strict blocking logic. + +## Subscribeable and shareable allow/denylists for federation + +Import and export allowlists and denylists. Subscribe to community-created blocklists (think Adblocker, but for federation!). + +## Various federation modes + +* 'Normal' federation; discover new servers. +* Allowlist-only federation; choose which servers you talk to. +* Zero federation; keep your server private. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 579268096..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. GoToSocial documentation master file, created by -   sphinx-quickstart on Sun Feb 28 12:01:26 2021. -   You can adapt this file completely to your liking, but it should at least -   contain the root `toctree` directive. - -Welcome to GoToSocial's documentation! -====================================== - -.. toctree:: -   :maxdepth: 2 -   :hidden: -   :caption: About GoToSocial - -   pages/about/index - -.. toctree:: -   :maxdepth: 2 -   :hidden: -   :caption: Design - -   pages/design/index - -.. toctree:: -   :maxdepth: 2 -   :hidden: -   :caption: Developer Docs - -   pages/api/index diff --git a/docs/installation_guide/docker.md b/docs/installation_guide/docker.md new file mode 100644 index 000000000..532ffe839 --- /dev/null +++ b/docs/installation_guide/docker.md @@ -0,0 +1,3 @@ +# Docker + +Installing with Docker.... diff --git a/docs/installation_guide/license.md b/docs/installation_guide/license.md new file mode 100644 index 000000000..82e3776b6 --- /dev/null +++ b/docs/installation_guide/license.md @@ -0,0 +1,669 @@ +# License + +GoToSocial is licensed under the [GNU AFFERO GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/agpl-3.0.html), the full text of which is given below. + +Copyright (C) 2021 [GoToSocial Authors](mailto:admin@gotosocial.org) + +```license +                    GNU AFFERO GENERAL PUBLIC LICENSE +                       Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +                            Preamble + +  The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +  The licenses for most software and other practical works are designed +to take away your freedom to share and change the works.  By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + +  When we speak of free software, we are referring to freedom, not +price.  Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +  Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +  A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate.  Many developers of free software are heartened and +encouraged by the resulting cooperation.  However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +  The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community.  It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server.  Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +  An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals.  This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + +  The precise terms and conditions for copying, distribution and +modification follow. + +                       TERMS AND CONDITIONS + +  0. Definitions. + +  "This License" refers to version 3 of the GNU Affero General Public License. + +  "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + +  "The Program" refers to any copyrightable work licensed under this +License.  Each licensee is addressed as "you".  "Licensees" and +"recipients" may be individuals or organizations. + +  To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy.  The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + +  A "covered work" means either the unmodified Program or a work based +on the Program. + +  To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy.  Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +  To "convey" a work means any kind of propagation that enables other +parties to make or receive copies.  Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + +  An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License.  If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +  1. Source Code. + +  The "source code" for a work means the preferred form of the work +for making modifications to it.  "Object code" means any non-source +form of a work. + +  A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +  The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form.  A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +  The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities.  However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work.  For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +  The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + +  The Corresponding Source for a work in source code form is that +same work. + +  2. Basic Permissions. + +  All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met.  This License explicitly affirms your unlimited +permission to run the unmodified Program.  The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work.  This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +  You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force.  You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright.  Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + +  Conveying under any other circumstances is permitted solely under +the conditions stated below.  Sublicensing is not allowed; section 10 +makes it unnecessary. + +  3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +  No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +  When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + +  4. Conveying Verbatim Copies. + +  You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +  You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +  5. Conveying Modified Source Versions. + +  You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + +    a) The work must carry prominent notices stating that you modified +    it, and giving a relevant date. + +    b) The work must carry prominent notices stating that it is +    released under this License and any conditions added under section +    7.  This requirement modifies the requirement in section 4 to +    "keep intact all notices". + +    c) You must license the entire work, as a whole, under this +    License to anyone who comes into possession of a copy.  This +    License will therefore apply, along with any applicable section 7 +    additional terms, to the whole of the work, and all its parts, +    regardless of how they are packaged.  This License gives no +    permission to license the work in any other way, but it does not +    invalidate such permission if you have separately received it. + +    d) If the work has interactive user interfaces, each must display +    Appropriate Legal Notices; however, if the Program has interactive +    interfaces that do not display Appropriate Legal Notices, your +    work need not make them do so. + +  A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit.  Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +  6. Conveying Non-Source Forms. + +  You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + +    a) Convey the object code in, or embodied in, a physical product +    (including a physical distribution medium), accompanied by the +    Corresponding Source fixed on a durable physical medium +    customarily used for software interchange. + +    b) Convey the object code in, or embodied in, a physical product +    (including a physical distribution medium), accompanied by a +    written offer, valid for at least three years and valid for as +    long as you offer spare parts or customer support for that product +    model, to give anyone who possesses the object code either (1) a +    copy of the Corresponding Source for all the software in the +    product that is covered by this License, on a durable physical +    medium customarily used for software interchange, for a price no +    more than your reasonable cost of physically performing this +    conveying of source, or (2) access to copy the +    Corresponding Source from a network server at no charge. + +    c) Convey individual copies of the object code with a copy of the +    written offer to provide the Corresponding Source.  This +    alternative is allowed only occasionally and noncommercially, and +    only if you received the object code with such an offer, in accord +    with subsection 6b. + +    d) Convey the object code by offering access from a designated +    place (gratis or for a charge), and offer equivalent access to the +    Corresponding Source in the same way through the same place at no +    further charge.  You need not require recipients to copy the +    Corresponding Source along with the object code.  If the place to +    copy the object code is a network server, the Corresponding Source +    may be on a different server (operated by you or a third party) +    that supports equivalent copying facilities, provided you maintain +    clear directions next to the object code saying where to find the +    Corresponding Source.  Regardless of what server hosts the +    Corresponding Source, you remain obligated to ensure that it is +    available for as long as needed to satisfy these requirements. + +    e) Convey the object code using peer-to-peer transmission, provided +    you inform other peers where the object code and Corresponding +    Source of the work are being offered to the general public at no +    charge under subsection 6d. + +  A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +  A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling.  In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage.  For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product.  A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + +  "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source.  The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + +  If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information.  But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +  The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed.  Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + +  Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +  7. Additional Terms. + +  "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law.  If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +  When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it.  (Additional permissions may be written to require their own +removal in certain cases when you modify the work.)  You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +  Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + +    a) Disclaiming warranty or limiting liability differently from the +    terms of sections 15 and 16 of this License; or + +    b) Requiring preservation of specified reasonable legal notices or +    author attributions in that material or in the Appropriate Legal +    Notices displayed by works containing it; or + +    c) Prohibiting misrepresentation of the origin of that material, or +    requiring that modified versions of such material be marked in +    reasonable ways as different from the original version; or + +    d) Limiting the use for publicity purposes of names of licensors or +    authors of the material; or + +    e) Declining to grant rights under trademark law for use of some +    trade names, trademarks, or service marks; or + +    f) Requiring indemnification of licensors and authors of that +    material by anyone who conveys the material (or modified versions of +    it) with contractual assumptions of liability to the recipient, for +    any liability that these contractual assumptions directly impose on +    those licensors and authors. + +  All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10.  If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term.  If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +  If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +  Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + +  8. Termination. + +  You may not propagate or modify a covered work except as expressly +provided under this License.  Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +  However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + +  Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +  Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License.  If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +  9. Acceptance Not Required for Having Copies. + +  You are not required to accept this License in order to receive or +run a copy of the Program.  Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance.  However, +nothing other than this License grants you permission to propagate or +modify any covered work.  These actions infringe copyright if you do +not accept this License.  Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +  10. Automatic Licensing of Downstream Recipients. + +  Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License.  You are not responsible +for enforcing compliance by third parties with this License. + +  An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations.  If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +  You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License.  For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +  11. Patents. + +  A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based.  The +work thus licensed is called the contributor's "contributor version". + +  A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version.  For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +  Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +  In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement).  To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +  If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients.  "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +  If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +  A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License.  You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + +  Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +  12. No Surrender of Others' Freedom. + +  If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License.  If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all.  For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + +  13. Remote Network Interaction; Use with the GNU General Public License. + +  Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software.  This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + +  Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work.  The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +  14. Revised Versions of this License. + +  The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time.  Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +  Each version is given a distinguishing version number.  If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation.  If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + +  If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +  Later license versions may give you additional or different +permissions.  However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +  15. Disclaimer of Warranty. + +  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +  16. Limitation of Liability. + +  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +  17. Interpretation of Sections 15 and 16. + +  If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +                     END OF TERMS AND CONDITIONS + +            How to Apply These Terms to Your New Programs + +  If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + +  To do so, attach the following notices to the program.  It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + +    <one line to give the program's name and a brief idea of what it does.> +    Copyright (C) <year>  <name of author> + +    This program is free software: you can redistribute it and/or modify +    it under the terms of the GNU Affero General Public License as published by +    the Free Software Foundation, either version 3 of the License, or +    (at your option) any later version. + +    This program is distributed in the hope that it will be useful, +    but WITHOUT ANY WARRANTY; without even the implied warranty of +    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the +    GNU Affero General Public License for more details. + +    You should have received a copy of the GNU Affero General Public License +    along with this program.  If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + +  If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source.  For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code.  There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + +  You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<http://www.gnu.org/licenses/>. +``` diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 2119f5109..000000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF
 -
 -pushd %~dp0
 -
 -REM Command file for Sphinx documentation
 -
 -if "%SPHINXBUILD%" == "" (
 -	set SPHINXBUILD=sphinx-build
 -)
 -set SOURCEDIR=.
 -set BUILDDIR=_build
 -
 -if "%1" == "" goto help
 -
 -%SPHINXBUILD% >NUL 2>NUL
 -if errorlevel 9009 (
 -	echo.
 -	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
 -	echo.installed, then set the SPHINXBUILD environment variable to point
 -	echo.to the full path of the 'sphinx-build' executable. Alternatively you
 -	echo.may add the Sphinx directory to PATH.
 -	echo.
 -	echo.If you don't have Sphinx installed, grab it from
 -	echo.http://sphinx-doc.org/
 -	exit /b 1
 -)
 -
 -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 -goto end
 -
 -:help
 -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 -
 -:end
 -popd
 diff --git a/docs/pages/about/about.rst b/docs/pages/about/about.rst deleted file mode 100644 index ada763d54..000000000 --- a/docs/pages/about/about.rst +++ /dev/null @@ -1,42 +0,0 @@ -Overview --------- - -GoToSocial will solve your problem of where to start with documentation, -by providing a basic explanation of how to do it easily. - -Look how easy it is to use:: - -    import project -    # Get your stuff done -    project.do_stuff() - -Features --------- - -- Be awesome -- Make things faster - -Installation ------------- - -Install $project by running: - -    install project - -Open Source ------------ - -GoToSocial is a free and open-source project. - -- Issue Tracker: https://github.com/gotosocial/gotosocial/issues -- Source Code: https://github.com/gotosocial/gotosocial - -Support -------- - -If you are having issues, please let us know. - -License -------- - -GoToSocial is licensed under the `GNU AFFERO GENERAL PUBLIC LICENSE <https://github.com/gotosocial/gotosocial/blob/main/LICENSE>`_ (AGPLv3). diff --git a/docs/pages/about/index.rst b/docs/pages/about/index.rst deleted file mode 100644 index 75852d3c3..000000000 --- a/docs/pages/about/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -About GoToSocial ----------------- - -These documents give a general overview of what GoToSocial is, and what it's trying to achieve. - -.. toctree:: -    :maxdepth: 1 - -    about diff --git a/docs/pages/api/activitypub.rst b/docs/pages/api/activitypub.rst deleted file mode 100644 index fd47c7ef3..000000000 --- a/docs/pages/api/activitypub.rst +++ /dev/null @@ -1,4 +0,0 @@ -ActivityPub / Federation ------------------------- - -This document describes the API used for federating with other ActivityPub instances. diff --git a/docs/pages/api/client.rst b/docs/pages/api/client.rst deleted file mode 100644 index c74f5887f..000000000 --- a/docs/pages/api/client.rst +++ /dev/null @@ -1,4 +0,0 @@ -Client APIs ------------ - -This document describes the client APIs exposed by GoToSocial to the outside world. diff --git a/docs/pages/api/index.rst b/docs/pages/api/index.rst deleted file mode 100644 index b41c49b7a..000000000 --- a/docs/pages/api/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -API ---- - -These pages describe the different APIs provided by GoToSocial, both for front-end (client) interaction, -and for federation. The intended audience for these documents is developers looking to implement a front-end -or bot for GoToSocial. - -.. toctree:: -    :maxdepth: 1 - -    internal -    client -    activitypub diff --git a/docs/pages/api/internal.rst b/docs/pages/api/internal.rst deleted file mode 100644 index d2a4b201c..000000000 --- a/docs/pages/api/internal.rst +++ /dev/null @@ -1,4 +0,0 @@ -Internal --------- - -This document describes the internal APIs used by GoToSocial. diff --git a/docs/pages/design/federation.rst b/docs/pages/design/federation.rst deleted file mode 100644 index d6f4ea88b..000000000 --- a/docs/pages/design/federation.rst +++ /dev/null @@ -1,6 +0,0 @@ -Federation ----------- - -In the spirit of Mastodon and other `Fediverse <https://en.wikipedia.org/wiki/Fediverse>`_ ("federation universe") applications, -GoToSocial uses the `ActivityPub <https://www.w3.org/TR/activitypub/>`_ protocol to communicate between its own servers and those -of compliant software. diff --git a/docs/pages/design/index.rst b/docs/pages/design/index.rst deleted file mode 100644 index 93f1a3486..000000000 --- a/docs/pages/design/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -GoToSocial Design ------------------ - -These documents describe the design of GoToSocial and provide rationale for design decisions, safety features, etc. - -.. toctree:: -    :maxdepth: 1 - -    federation -    safety_features diff --git a/docs/pages/design/safety_features.rst b/docs/pages/design/safety_features.rst deleted file mode 100644 index ddecfc9a3..000000000 --- a/docs/pages/design/safety_features.rst +++ /dev/null @@ -1,4 +0,0 @@ -Safety Features ---------------- - -Blah blah blah blah.  | 
