Skip to content

Commit 7695fd2

Browse files
authored
Update README
1 parent 739914b commit 7695fd2

File tree

1 file changed

+1
-73
lines changed

1 file changed

+1
-73
lines changed

README

+1-73
Original file line numberDiff line numberDiff line change
@@ -1,73 +1 @@
1-
______ ______ _______ ____ ____
2-
|_ _ `.|_ _ `.|_ __ \|_ _| |_ _|
3-
| | `. \ | | `. \ | |__) | \ \ / /
4-
| | | | | | | | | __ / \ \ / /
5-
_| |_.' /_| |_.' /_| | \ \_ \ ' /
6-
|______.'|______.'|____| |___| \_/
7-
=========================================
8-
Not-so-conventional tool to exploit Discord's unlimited file attachment feature for an endless cloud storage solution.
9-
You're welcome.
10-
11-
12-
HIGHLIGHTS
13-
----------
14-
- Supports multiple protocols, HTTP and FTP (Yes you can mount as fuse using rclone).
15-
- The frontend is robust. Works with web browsers (HTTP), Filezilla, RClone, Windows Explorer, Ubuntu (Nautilus), and many more.
16-
- For storing file metadata, PostgreSQL and BoltDB (key/value store in pure Go) data providers are supported.
17-
- HTTP supports partial downloads, so you can use multi-threaded download managers and stream video directly to video players.
18-
19-
20-
NEW IN VERSION 2
21-
----------------
22-
- Ditched webhooks for bot tokens. Bot tokens were necessary to renew attachment url signature.
23-
- Discord attachment URL signature? Pfft. Found a workaround.
24-
- Zerolog logging library now. The standard one was just meh.
25-
- Configuration's now in "config.yaml" instead of ".env". Because consistency is overrated.
26-
- Added a new disk-based dataprovider using boltdb. For those who can't handle a full setup.
27-
- Webdav is out. It was a slow, broken mess and complete waste of time
28-
29-
30-
REQUIREMENTS
31-
-------------
32-
- Discord bot token. Make sure "message content intent" is on.
33-
- PostgreSQL - Optional (Data provider)
34-
35-
36-
USAGE
37-
-----
38-
- Get latest binary and config file from release page for your os/platform.
39-
- Update config.yaml according to your use case
40-
- Start Linux / Macos - './ddrv --config=config.yaml'
41-
- Start Windows - 'ddrv --config=config.yaml'
42-
43-
44-
USAGE DOCKER
45-
------------
46-
- Prepare config.yaml, find a sample config at 'https://github.com/forscht/ddrv/blob/main/config/config_example.yaml'
47-
- docker run -p="2525:2525" -p="2526:2526" -v="./config.yaml:/app/config.yaml" --rm --name=ddrv forscht/ddrv
48-
49-
50-
BUILD FROM SOURCE
51-
-----------------
52-
- Clone this repository
53-
- Command to build - 'go build -ldflags="-s -w" -o ddrv ./cmd/ddrv'
54-
55-
56-
CONFIGURATION FILE
57-
------------------
58-
- Find a sample config at 'https://github.com/forscht/ddrv/blob/main/config/config_example.yaml'.
59-
- ddrv automatically searches for a file named 'config.yaml' in below places
60-
- ./config.yaml (current directory)
61-
- $HOME/.config/ddrv/config.yaml
62-
- Alternatively, you can specify a different configuration file by using 'ddrv --config=/path-to-config/config.yaml'.
63-
64-
65-
SUPPORT
66-
-------
67-
- Create GitHub issue at - 'https://github.com/forscht/ddrv/issues'
68-
- Discord Server - 'https://discord.gg/bdxkPSEKzG'
69-
70-
71-
TODO
72-
----
73-
- Move pkg/ddrv to separate repository
1+
"a backup"

0 commit comments

Comments
 (0)