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

Commit 0f54b5c

Browse files
committed
Update docs
1 parent c4caa52 commit 0f54b5c

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

ConfigDocs.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,24 @@
44
All settings regarding how the bot will work can be configured here.
55

66
* `"steemAPIURL"` (String): Sets Steem API server
7+
* `"IPFS_API_Port"` (Integer): Sets the IPFS API port the bot should use while communicating with IPFS daemon
78
* `"communityAccount"` (String): Sets community Steem account for collectiong donations (e.g. to pay for IPFS servers)
89
* `"trickledag"` (Bool): Enable trickledag pinning by setting it to true. You may have to try setting this to `false` if same IPFS hash (as downloaded file name) is obtained without trickledag option.
910
* `"silentModeEnabled"` (Boolean): If set to true, bot messages will be logged to the console instead of sending them to the chat. Excludes `Pong!` replies and download complete messages. Useful if running multiple instances of bot on different servers (and preferbly different geographical location)
1011
* `"sdOnlyMode"` (Boolean): If set to true, 720p, 1080p and source pinning commands will be disabled regardless of whitelists.
1112
* `"hdWhitelistEnabled"` (Boolean): If set to true, whitelisting system is enabled, therefore admins may whitelist certain users to that they can execute 720p, 1080p and source pinning commands.
13+
`"restrictedMode"` (Boolean): If set to true, only whitelisted users (if whitelisting system is enabled) may run any pinning commands regardless of resolutions.
1214
* `"donationsAccepted"` (Boolean): If set to true, donation commands are enabled.
1315
* `"commandPrefix"` (String): Any string before each bot command goes here. You may change the pre-configured `!` to something else so that it may not conflict with other bots that may be in the same Discord server.
16+
* `"nodeID"` (Number or String): A short unique identifier that may be used to filter `!stats` command. Alternatively, the entire peer ID of IPFS node may be used for filtering this command.
1417

1518
## Section 2: Bot Output Message
1619
Useful to tweak if running the bot on multiple servers to differentiate between instances.
1720

18-
Recommended to tweak: `PING_PEPLY`, `VIDEO_DOWNLOAD_COMPLETE` and `AUDIO_DOWNLOAD_COMPLETE`.
21+
Recommended to tweak:
22+
* `PING_PEPLY`
23+
* `VIDEO_DOWNLOAD_COMPLETE`
24+
* `AUDIO_DOWNLOAD_COMPLETE`
25+
* `ERROR_FILE_ALREADY_PINNED`
26+
* `IPFS_ID_MESSAGE_PREFIX`
27+
* `IPFS_STAT_EMBED_TITLE`

README.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,10 @@ Note: you may need increase the value of `--max_old_space_size` if several large
3030

3131
Use the link below to invite the bot to your Discord server:
3232

33-
`https://discordapp.com/oauth2/authorize?client_id=YOURCLIENTID&scope=bot&permissions=248897`
33+
`https://discordapp.com/oauth2/authorize?client_id=YOURCLIENTID&scope=bot`
3434

3535
(where `YOURCLIENTID` is the client ID of your Discord application)
3636

37-
#### To fetch all pinned files on IPFS node:
38-
39-
The text file is set to be updated whenever each file is pinned, or an unpin script is run. However, you may run the command below if you need to update it manually:
40-
41-
`ipfs pin ls -t recursive > Pinned/AllPinned.txt`
42-
4337
# Unpinning IPFS files
4438

4539
You may choose to unpin all IPFS files that were downloaded by a user by doing the following:
@@ -52,7 +46,7 @@ You may choose to unpin all IPFS files that were downloaded by a user by doing t
5246

5347
# Links support
5448

55-
The Discord bot command supports `d.tube`, `dsound.audio`, `steemit.com` and `busy.org` links. However, this bot only supports DTube videos and DSound audios at the moment. More platform support coming in the next few updates.
49+
The Discord bot command supports all kinds of links of Steem frontends, such as `d.tube`, `dtube.network`, `dsound.audio`, `steemit.com` and `busy.org`. However, this bot only supports DTube videos and DSound audios at the moment. More platform support coming in the next few updates.
5650

5751
# How to contribute
5852

0 commit comments

Comments
 (0)