forked from KayFaraday/pleroma-ebooks
update README
This commit is contained in:
io
parent
36a416da7a
commit
8c0041e8ad
46
README.md
46
README.md
|
|
@ -1,37 +1,9 @@
|
|||
# mstdn-ebooks
|
||||
**Lynnear Edition**
|
||||
# pleroma-ebooks
|
||||
|
||||
This version makes quite a few changes from [the original](https://github.com/Jess3Jane/mastodon-ebooks), such as:
|
||||
- Unicode support
|
||||
- Non-Markov stuff
|
||||
- Stores toots in a sqlite database rather than a text file
|
||||
- Doesn't unnecessarily redownload all toots every time
|
||||
- Ability to ignore specific CWs
|
||||
- Fixes Pleroma post fetching
|
||||
- Fixes Pleroma post replying too
|
||||
|
||||
## FediBooks
|
||||
Before you use mstdn-ebooks to create your own ebooks bot, I recommend checking out [FediBooks](https://fedibooks.com). Compared to mstdn-ebooks, FediBooks offers a few advantages:
|
||||
- Hosted and maintained by someone else - you don't have to worry about updating, keeping the computer on, etc
|
||||
- No installation required
|
||||
- A nice UI for managing your bot(s)
|
||||
- Easy configuration
|
||||
|
||||
However, there are still a few reasons you might want to use mstdn-ebooks instead:
|
||||
- Your data stays local to your machine
|
||||
- More customisation potential - you can edit mstdn-ebooks to add functionality
|
||||
- Replying more (in)frequently than FediBooks allows
|
||||
|
||||
Like mstdn-ebooks, FediBooks is free, both as in free of charge and free to modify, self-host, and more.
|
||||
It's like [@AgathaSorceress's mstdn-ebooks] but it supports Pleroma better.
|
||||
|
||||
## Secure Fetch
|
||||
Secure fetch (aka authorised fetches, authenticated fetches, secure mode...) is *not* supported by mstdn-ebooks, and will fail to download any posts from users on instances with secure fetch enabled. For more information, see [this wiki page](https://github.com/Lynnesbian/mstdn-ebooks/wiki/Secure-fetch).
|
||||
|
||||
## Install/usage Guide
|
||||
An installation and usage guide is available [here](https://cloud.lynnesbian.space/s/jozbRi69t4TpD95). It's primarily targeted at Linux, but it should be possible on BSD, macOS, etc. I've also put some effort into providing steps for Windows, but I can't make any guarantees as to its effectiveness.
|
||||
|
||||
### Docker
|
||||
While there is a Docker version provided, it is **not guaranteed to work**. I personally don't use Docker and don't know how the Dockerfile works; it was create over a year ago by someone else and hasn't been updated since. It might work for you, it might not. If you'd like to help update the Dockerfile, please get in touch with me on the Fediverse.
|
||||
Secure fetch (aka authorised fetches, authenticated fetches, secure mode...) is *not* supported by pleroma-ebooks, and will fail to download any posts from users on instances with secure fetch enabled. For more information, see [this wiki page](https://github.com/Lynnesbian/mstdn-ebooks/wiki/Secure-fetch).
|
||||
|
||||
## Compatibility
|
||||
| Software | Downloading statuses | Posting | Replying |
|
||||
|
|
@ -44,22 +16,22 @@ While there is a Docker version provided, it is **not guaranteed to work**. I pe
|
|||
|
||||
*Note: Bots are only supported on Mastodon and Pleroma instances. Bots can learn from users on other instances, but the bot itself must run on either a Mastodon or Pleroma instance.*
|
||||
|
||||
mstdn-ebooks uses ActivityPub to download posts. This means that it is not dependant on any particular server software, and should work with anything that (properly) implements ActivityPub. Any software that does not support ActivityPub (e.g. diaspora*) is not supported, and won't work.
|
||||
pleroma-ebooks uses ActivityPub to download posts. This means that it is not dependant on any particular server software, and should work with anything that (properly) implements ActivityPub. Any software that does not support ActivityPub (e.g. diaspora*) is not supported, and won't work.
|
||||
|
||||
I recommend that you create your bot's account on a Mastodon instance. Creating a bot on a Pleroma instance means that your bot will be unable to reply, although posting will work just fine. However, even if your bot is on a Mastodon instance, it will be able to learn from any Pleroma or Misskey users just fine.
|
||||
|
||||
## Configuration
|
||||
Configuring mstdn-ebooks is accomplished by editing `config.toml`. If you want to use a different file for configuration, specify it with the `--cfg` argument. For example, if you want to use `/home/lynne/c.json` instead, you would run `python3 main.py --cfg /home/lynne/c.json` instead of just `python3 main.py`
|
||||
Configuring pleroma-ebooks is accomplished by editing `config.toml`. If you want to use a different file for configuration, specify it with the `--cfg` argument. For example, if you want to use `/home/lynne/c.json` instead, you would run `python3 main.py --cfg /home/lynne/c.json` instead of just `python3 main.py`
|
||||
|
||||
| Setting | Default | Meaning |
|
||||
|--------------------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| site | https://botsin.space | The instance your bot will log in to and post from. This must start with `https://` or `http://` (preferably the latter) |
|
||||
| cw | null | The content warning (aka subject) mstdn-ebooks will apply to non-error posts. |
|
||||
| learn_from_cw | false | If true, mstdn-ebooks will learn from CW'd posts. |
|
||||
| cw | null | The content warning (aka subject) pleroma-ebooks will apply to non-error posts. |
|
||||
| learn_from_cw | false | If true, pleroma-ebooks will learn from CW'd posts. |
|
||||
| ignored_cws | [] | If `learn_from_cw` is true, do not learn from posts with these CWs.
|
||||
| mention_handling | 1 | 0: Never use mentions. 1: Only generate fake mentions in the middle of posts, never at the start. 2: Use mentions as normal (old behaviour). |
|
||||
| max_thread_length | 15 | The maximum number of bot posts in a thread before it stops replying. A thread can be 10 or 10000 posts long, but the bot will stop after it has posted `max_thread_length` times. |
|
||||
| strip_paired_punctuation | false | If true, mstdn-ebooks will remove punctuation that commonly appears in pairs, like " and (). This avoids the issue of posts that open a bracket (or quote) without closing it. |
|
||||
| strip_paired_punctuation | false | If true, pleroma-ebooks will remove punctuation that commonly appears in pairs, like " and (). This avoids the issue of posts that open a bracket (or quote) without closing it. |
|
||||
| limit_length | false | If true, the sentence length will be random between `length_lower_limit` and `length_upper_limit` |
|
||||
| length_lower_limit | 5 | The lower bound in the random number range above. Only matters if `limit_length` is true. |
|
||||
| length_upper_limit | 50 | The upper bound in the random number range above. Can be the same as `length_lower_limit` to disable randomness. Only matters if `limit_length` is true. |
|
||||
|
|
@ -75,3 +47,5 @@ Please don't feel obligated to donate at all.
|
|||
## License
|
||||
|
||||
This is released under the EUPL 1.2 license, and based on Lynnesbian's fork which is under the MPL 2.0 license. See LICENSE-EUPL and LICENSE-MPL for details.
|
||||
|
||||
**This means you must publish the source code of any ebooks bot you make with this.** A link back to this repository on your bot's profile page or profile metadata will suffice. If you make changes to the code you need to link to your fork/repo instead
|
||||
|
|
|
|||
Loading…
Reference in New Issue