Merge pull request #258 from hughrun/v0.8.3

V0.8.3

Author: hughrun

content/codebase/_meta.yml

@@ -1,2 +1,2 @@
 title: Codebase
-order: 4
+order: 5

content/managing_bookwyrm/_meta.yml

@@ -0,0 +1,2 @@
+title: Managing BookWyrm
+order: 2

content/managing_bookwyrm/federation.md

@@ -0,0 +1,17 @@
+---
+Title: Federation
+Date: 2026-01-18
+Order: 2
+---
+
+## Federation Settings
+
+Administrators and moderators can disable federation completely. This will prevent any further communication inwards or outwards, however existing data will be retained in the database. Disabling federation does not prevent connectors from importing books, however it will restrict all statuses (reviews, comments etc) to only users on your instance, or anything those users import manually (e.g. via a Goodreads CSV import).
+
+To disable federation, go to `Admin > Federation > Federation Settings`.
+
+## Federated Instances
+
+At `Admin > Federation > Federated Instances` you can see all instances connected to yours via federation. This list may be quite long, as it will include every ActivityPub server that has sent or received a status or object. This list will show you the instance domain and software the instance is running.
+
+You can click on the instance domain to find out more information about the instance including how many users have come from that instance. You can also block the instance completely from here.

content/managing_bookwyrm/moderation.md

@@ -0,0 +1,52 @@
+---
+Title: Moderation
+Date: 2021-04-18
+Order: 3
+---
+
+## User actions
+
+### Blocking
+Users have the option to block other users on their own, without a moderator intervening. From the "Federated Servers" admin view, administrators can see how many users from an instance have been blocked by local users.
+
+### Reports
+Users can report statuses or users from the "more options" menu in the footer of posts and the follow/unfollow buttons for users. When a report is made, all users with admin permissions will receive a notification.
+
+To manage reports, go to `Admin > Moderation > Reports`.
+
+When a report is made, there are a few options how the moderator can respond.
+- Send a direct message to the reported user.
+- Delete the reported status.
+- Deactivate the user. For local users, this will make them unable to log in, and their account will not be shown in the application. For remote users, the server will reject any incoming activities from this user, and they will not be shown in searches.
+
+## Auto-moderation
+
+Auto-moderation rules will create reports for any local user or status with fields matching the provided string. Users or statuses that have already been reported (regardless of whether the report was resolved) will not be flagged. To set up auto-moderation, go to `Admin > Moderation > Auto-Moderation Rules`.
+
+## Instance-level moderation
+
+### Manual instance blocks
+
+Moderators can block entire instances. This will prevent any activities from coming in from that instance, and deactivate all accounts from that instance locally. To block an instance go to `Admin > Federated Instances` and find the instance you wish to block. See `Managing BookWyrm > Federation` for more information.
+
+If the instance is un-blocked, all the users who were deactivated by the block will be re-activated.
+
+### FediBlock lists
+
+Moderators can also upload _FediBlock_ formatted blocklists to block servers in bulk. To do this, go to `Federation > Federated Instances` and click on "Add instance".
+
+### Email and IP block lists
+
+You can block signups from a given email domain at `Admin > Moderation > Email Blocklist`. When someone tries to register with an email from a domain in your email blocklist, no account will be created. The registration process will appear to have worked.
+
+An IP block list will block all traffic from the IP address. Requests to any part of your instance from these IPs will receive a 404 response.
+
+### Link Domains
+
+Users can add a link to a book download for any book. Link domains must be approved before they are shown on book pages in order to avoid spam and malicious links. You can approve link domains at `Admin > Moderation > Link Domains`.
+
+## Disabling federation
+Administrators and moderators can disable federation completely. This will prevent any further communication inwards or outwards, however existing data will be retained in the database. Disabling federation does not prevent connectors from importing books, however it will restrict all statuses (reviews, comments etc) to only users on your instance, or anything those users import manually (e.g. via a Goodreads CSV import).
+
+To disable federation, go to `Admin > Federation > Federation Settings`.
+

content/managing_bookwyrm/settings.md

@@ -0,0 +1,23 @@
+---
+Title: Instance Settings
+Date: 2021-04-18
+Order: 5
+---
+
+## Announcements
+
+You can create an **Announcement** from `Admin > Instance Settings > Announcements`. Announcements appear as a banner at the top of every page until a user dismisses them. Announcements can be used for anything, but generally would be used to alert users to expected down time or changes to configuration.
+
+Announcements can be related to a particular date (e.g. a scheduled upgrade or down time), and you can also schedule the announcement itself to begin and/or end on a given date.
+
+## Site Settings
+
+When you first set up your instance you will be directed to the **Site Settings** page. Here you can edit your basic instance information including name, description, a code of conduct, and other details. This is also where you can upload a logo, set up footer details, and select a default theme.
+
+## Registration
+
+The **Registration** page of the Instance Settings section is where you can enable or disable registration, decide whether to require users to confirm their email address, allow or disallow invite requests, and set a question for invite requests (useful for slowing down or identifying automated requests).
+
+## Themes
+
+BookWyrm comes with default themes, however you can add your own custom theme. Themes should be `.scss` files.

content/managing_bookwyrm/system.md

@@ -0,0 +1,41 @@
+---
+Title: System Monitoring
+Date: 2021-04-18
+Order: 4
+---
+
+The `Admin > System` menu provides instance admins with a number of system monitoring features, and configuration options for background tasks.
+
+## Imports
+
+From the **Imports** page you can manage imports for books and both imports and exports for users. user exports are disabled by default. From this page you can monitor and, if necessary, cancel Book and User imports if they are causing errors, as well as setting limits on how often users can run imports. This is important if your instance is suffering performance problems due to a large number of import or export background jobs.
+
+## Celery Status
+
+The **Celery Status** page provides an overview of celery tasks and can provide an indication of which queues may be causing issues if your instance has become slow. From this page you can also clear entire queues and tasks, however this is generally a last resort as it may lead to data loss.
+
+## Scheduled Tasks
+
+You can monitor tasks schedules at `Admin > System > Scheduled Tasks`. Tasks are triggered from other pages.
+
+## Email configuration
+
+Check your outgoing email configuration here, and trigger a test email. This page may move in future.
+
+## Connectors
+
+Connectors are sources of data about books and authors. From this page you can enable or disable connectors, and set their priority. Other BookWyrm servers, Inventaire, and Open Library are enabled by default.
+
+The priority determines the order in which search results appear. The highest priority is 1. The default priority is 2. Connector settings only determine whether a connector will be used to deliver search results. To handle federation and moderation, see `Admin > Federation` or `Admin > Moderation`.
+
+## Files maintenance
+
+This section is where you can configure a number of background jobs related to export and import files, and book cover images.
+
+At **Schedule file deletion** you can schedule a regular job to delete user import and export files that have reached their expiry age. The expiry age is determined at **Export file expiration**.
+
+The **Find book covers from connectors** section can help you with two different but related problems.
+
+With **Find missing covers** you can set up a regular job to check for any books in your local database that do not have a cover image listed. This job searches Connectors for cover images they may be able to provide. This will, for example, enable you to pull in a cover image from a connected BookWyrm instance where it has recently been uploaded but there has not been any trigger for your instance to add the updated cover image. This can be resource intensive as it will run a search for every book in your database without a cover, so be cautious about how often you set this job to run.
+
+The **Fix broken book cover filepaths** can be triggered, but not scheduled as a regular job. Most administrators will not need to run this job. This is designed to fix problems from server migrations where book records list a cover image, but the file does not exist in your file storage.

content/managing_bookwyrm/users.md

@@ -0,0 +1,28 @@
+---
+Title: Managing users
+Date: 2026-01-18
+Order: 1
+---
+
+## Managing individual users
+
+Administrators and moderators can manage indidual users from `Settings > Manage Users > Users`. This page shows all users in your database including local, federated, and deleted users. You can filter/search for indivual users, and by clicking on their username you will see the management page for an individual user. From here you may:
+
+* Send a direct message
+* Suspend the user
+* Permanently delete the user
+* Change their access level (e.g. to upgrade an editor to a moderator).
+
+## Invites
+
+From `Settings > Manage Users > Invites` you can see all invite requests and invite codes.
+
+**Invite Requests** are requests from potential users who would like to join. These requests can be made when _Allow invite requests_ is ticked in `Admin > Instance settings > Registration`. From the _Invite Requests_ tab you can choose to _Send invite_ to allow the user to join, or _Ignore_ if you do not want to allow them to join your instance.
+
+From the **Invites** tab you can create invite links to send or publish. You can set an expiry date, and a maximum number of uses for each link.
+
+## Force Password Reset
+
+From the **Force Password Reset** page you can force a password reset for any group of users by category (user, editor, moderator, etc) or for all users. This may be required, for example, if you believe you may have had a security incident potentially compromising user passwords.
+
+Note that if you select "All users", you will also be logged out and required to reset your password.

content/reference/_meta.yml

@@ -1,2 +1,2 @@
 title: Reference Guides
-order: 5
+order: 6

content/running_bookwyrm/_meta.yml

@@ -1,2 +1,2 @@
 title: Running BookWyrm
-order: 2
+order: 3