update doc to add language settings

This commit is contained in:
Your Name 2024-07-08 02:21:00 -04:00 committed by Henri Dickson
parent 0276d7ca98
commit 18b6e9ab45
4 changed files with 10 additions and 2 deletions

View file

@ -24,6 +24,7 @@ if you are doing debug or development:
- `NEODB_SITE_INTRO`
- `NEODB_SITE_HEAD`
- `NEODB_SITE_DESCRIPTION`
- `NEODB_LANGUAGE` - default language when importing titles from 3rd party sites like TMDB and Steam, set it to one of `en` / `zh-hans` / `zh-hant`
- `NEODB_SITE_LINKS` - a list of title and links to show in the footer, comma separated, e.g. `Feedback=https://discord.gg/8KweCuApaK,ToS=/pages/rules/`
- `NEODB_INVITE_ONLY` - `False` by default, set to `True` to require invite code(generated by `neodb-manage invite --create`) to register
- `NEODB_ENABLE_LOCAL_ONLY` - `False` by default, set to `True` to allow user to post marks as "local public"

View file

@ -27,6 +27,7 @@ NeoDB has [various features](features.md), and you may image it as a mix of Mast
- mark an item as wishlist/in progress/complete/dropped
- rate and write reviews for an item
- write notes for an item with progress (e.g. reading notes at page 42)
- create tags for an item, either privately or publicly
- create and share list of items
- tracking progress of a list (e.g. personal reading challenges)
@ -54,6 +55,11 @@ NeoDB has [various features](features.md), and you may image it as a mix of Mast
- implementation is based on [Takahē](https://jointakahe.org/) server
## API
- Mastodon compatible API
- most mastodon compatible apps are compatible with NeoDB
- NeoDB API to manage reviews and collections
## Languages
- English

View file

@ -1,4 +1,4 @@
NeoDB is an open-source software and global community platform [since 2021](origin.md). It allows users to manage and explore collections, reviews, and ratings for various cultural products, including books, movies, music, podcasts, games, and performances. Additionally, users can share their collections, publish microblogs, and engage with others in the Fediverse. NeoDB integrates the functionalities of platforms like Goodreads, Letterboxd, RateYourMusic, and Podchaser, among others. It also supports self-hosting and interconnection through containerized deployment and the ActivityPub protocol.
NeoDB is an open-source software and global community platform [since 2021](origin.md). It helps users to manage and explore collections, reviews, and ratings for various cultural products, including books, movies, music, podcasts, games, and performances. Additionally, users can share their collections, publish microblogs, and engage with others in the Fediverse. NeoDB integrates the functionalities of platforms like Goodreads, Letterboxd, RateYourMusic, and Podchaser, among others. It also supports self-hosting and interconnection through containerized deployment and the ActivityPub protocol.
This project is licensed under AGPLv3.

View file

@ -24,7 +24,7 @@ Follow [official instructions](https://docs.docker.com/engine/install/linux-post
## Prepare configuration files
- create a folder for configuration, eg ~/mysite/config
- grab [compose.yml](https://raw.githubusercontent.com/neodb-social/neodb/main/compose.yml) and [neodb.env.example](https://raw.githubusercontent.com/neodb-social/neodb/main/neodb.env.example) from source code
- grab `compose.yml` and `neodb.env.example` from [latest release](https://github.com/neodb-social/neodb/releases)
- rename `neodb.env.example` to `.env`
@ -36,6 +36,7 @@ Change essential options like `NEODB_SITE_DOMAIN` in `.env` before starting the
- `NEODB_SECRET_KEY` - encryption key of session data
- `NEODB_DATA` is the path to store db/media/cache, it's `../data` by default, but can be any path that's writable
- `NEODB_DEBUG` - set to `False` for production deployment
- `NEODB_LANGUAGE` - default language when importing titles from 3rd party sites like TMDB and Steam, set it to one of `en` / `zh-hans` / `zh-hant`
Optionally, `robots.txt` and `logo.png` may be placed under `$NEODB_DATA/www-root/`.