update instructions
- fix docs Home link being wrong - add --verbose to options page in docs - add info about where to see docs, in init()
This commit is contained in:
parent
94ac7869d1
commit
2ab8c55bac
|
@ -24,15 +24,20 @@ Now you've installed `ephemetoot`, in order to actually use it you will need an
|
|||
1. Click the `settings` cog
|
||||
2. Click on `Development`
|
||||
3. Click `NEW APPLICATION`
|
||||
4. Enter an application name (e.g. 'ephemetoot'), and give the app both 'read' and 'write' Scopes
|
||||
4. Enter an application name (e.g. 'ephemetoot')
|
||||
5. The following 'scopes' are required:
|
||||
- `read:accounts`
|
||||
- `read:statuses`
|
||||
- `write:conversations`
|
||||
- `write:statuses`
|
||||
5. Click `SUBMIT`
|
||||
6. Click on the name of the new app, which should be a link
|
||||
7. Copy the `Your access token` string - you will need this for your configuration file (see below)
|
||||
|
||||
**NOTE**: Anyone who has your access token and the domain name of your Mastodon server will be able to:
|
||||
* read all your private and direct toots,
|
||||
* publish toots and DMs, and
|
||||
* delete everything in your account.
|
||||
* publish toots and DMs from your account, and
|
||||
* read everything in your account settings.
|
||||
|
||||
**Do not share your access token with anyone you do not 100% trust!!!**.
|
||||
|
||||
|
@ -72,7 +77,7 @@ visibility_to_keep: [ ] # this empty list is also ok
|
|||
As of version 2, you can use a single `ephemetoot` installation to delete toots from multiple accounts. If you want to use `ephemetoot` for multiple accounts, separate the config for each user with a single dash (`-`), and add the additional details, as shown in [the example file](https://github.com/hughrun/ephemetoot/blob/master/example-config.yaml).
|
||||
|
||||
---
|
||||
* [Home](/)
|
||||
* [Home](./)
|
||||
* [Options](./options.md)
|
||||
* [Upgrading and uninstalling](./upgrade.md)
|
||||
* [Contributing](./contributing.md)
|
|
@ -57,6 +57,10 @@ ephemetoot --retry-mins 20
|
|||
|
||||
If you want to know exactly when each delete action occured, you can use the `--datestamp` flag to add a datestamp to the log output. This is useful when using `--pace` so you can see the rate you have been slowed down to.
|
||||
|
||||
### Include full error messages (--verbose)
|
||||
|
||||
Sometimes you might get an error and want to know more about what's triggering it. Use the `--verbose` flag to print the full error to the console, instead of just the friendly version.
|
||||
|
||||
## Do less
|
||||
|
||||
### Hide skipped items (--hide-skipped)
|
||||
|
|
|
@ -63,6 +63,16 @@ def init():
|
|||
# text colour markers (beginning, example, end)
|
||||
tags = ("\033[96m", "\033[2m", "\033[0m")
|
||||
|
||||
print("\nCreate your config.yaml file.\n")
|
||||
print(
|
||||
"For help checkout the docs at ",
|
||||
tags[0],
|
||||
"ephemetoot.hugh.run",
|
||||
tags[2],
|
||||
"\n",
|
||||
sep=""
|
||||
)
|
||||
|
||||
conf_token = compulsory_input(tags, "Access token: ", None)
|
||||
conf_user = compulsory_input(tags, "Username", "(without the '@' - e.g. alice):")
|
||||
conf_url = compulsory_input(tags, "Base URL", "(e.g. example.social):")
|
||||
|
|
Loading…
Reference in New Issue