Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

Commit a0b584b

Browse files
Merge pull request #3 from alphatownsman/main
update doc
2 parents d875d75 + 1b88bb7 commit a0b584b

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

docs/apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Apps
22

3-
NeoDB web version will provide the most features and experience, while some third-party apps are also available below.
3+
NeoDB web version works in desktop and mobile, and provides the most complete features and experience, meanwhile some third-party apps are also available below, they are not affliated with NeoDB unless otherwise specified.
44

55
## Apps for NeoDB
66

docs/configuration.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ if you are doing debug or development:
4141
- `anymail://<anymail_backend_name>?<anymail_args>`, to send email via email service providers, see [anymail doc](https://anymail.dev/)
4242

4343
## Settings for administration
44-
- `DISCORD_WEBHOOKS` - Discord channel to send notification about user submitted suggestion and changes, e.g. `suggest=https://discord.com/api/webhooks/123/abc,audit=https://discord.com/api/webhooks/123/def`. Both suggest and audit channels must be in forum mode.
44+
- `DISCORD_WEBHOOKS` - Discord channel to send notification about user submitted suggestion and changes, e.g. `suggest=https://discord.com/api/webhooks/123/abc,audit=https://discord.com/api/webhooks/123/def,report=https://discord.com/api/webhooks/123/xyz`. All channels must be in forum mode.
4545
- `NEODB_SENTRY_DSN` , `TAKAHE_SENTRY_DSN` - [Sentry](https://sentry.io/) DSN to log errors.
4646

4747
## Settings for Federation
@@ -52,6 +52,7 @@ if you are doing debug or development:
5252

5353
`relay.neodb.net` is [open sourced](https://github.com/neodb-social/neodb-relay) and operated by NeoDB developers, it works like most ActivityPub relays except it only relays between NeoDB instances, it helps public information like catalogs and trends flow between NeoDB instances. You may set it to `True` if you don't want to relay public posts with other NeoDB instances.
5454

55+
- `TAKAHE_NO_FEDERATION` set to `1` to disable federation with other fediverse sites. Please note this is only for test and development purpose, it may generate more error messages in backend, and will not prevent access from public.
5556

5657
## Settings for external item sources
5758

@@ -64,8 +65,9 @@ if you are doing debug or development:
6465

6566
## Translation
6667
set either of these will enable translation
67-
- `DEEPL_API_KEY` for DeepL
68-
- `LT_API_URL` and `LT_API_KEY` for LibreTranslate server
68+
69+
- `DEEPL_API_KEY` for [DeepL](https://www.deepl.com/)
70+
- `LT_API_URL` and `LT_API_KEY` for [LibreTranslate](https://libretranslate.com/) server
6971

7072
## Other maintenance tasks
7173

docs/features.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ NeoDB has [various features](features.md), and you may image it as a mix of Mast
4141

4242
## Social
4343

44+
- publish and reply post in text and image
4445
- view home feed with friends' activities
4546
- every activity can be set as viewable to self/follower-only/public
4647
- eligible items, e.g. podcasts and albums, are playable in feed

0 commit comments

Comments
 (0)