Skip to content

Commit 068de1d

Browse files
committed
sample config
1 parent b30ec7e commit 068de1d

File tree

2 files changed

+54
-6
lines changed

2 files changed

+54
-6
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@
44
Miss the old reddit mobile web/compact/wap interface (`i.reddit.com`, `.compact`)? Worry not, CompactBro brings it back!
55

66
1. Download & unzip a version for your platform -> https://github.com/rdtmaster/compactbro/releases/latest
7-
2. Rename `compactbro.sample.toml` -> `compactbro.toml`
7+
2. Rename `compactbro.sample.toml` -> `compactbro.toml` and copy to your default config directory
88
3. From your reddit account, Create a new app with script access, then specify your `secret`, `id`, reddit login and password in `compactbro.toml`. Link to do it -> https://old.reddit.com/prefs/apps
99
4. Launch the app
1010
5. http://localhost/ <- in your browser address bar
1111

12-
More (much more!) details below
13-
1412
## what it is?
1513
A reddit client for web that focuses on fast load time, old browser compatability and delivering user experience similar or at least reasonably close to that provided by i.reddit.com mobile interface, also known as `.compact`.
1614

@@ -44,12 +42,32 @@ compactbro.exe #on windows
4442
- Edit the config, it will look like this:
4543

4644
```toml
47-
EcoMode = false
45+
EcoMode = true
46+
MarkMsgsUnreadOnView = true
47+
CheckMsgs = true
48+
Logging = true
49+
DisplayFlairEmojis = true
50+
NightMode = false
51+
DefaultLimit = 25
52+
LocalAddress = "127.0.0.1:80"
53+
54+
[HTTPS]
55+
Use = true
56+
LocalAddress = "127.0.0.1:443"
57+
KeyPath = "/certs/key.pem"
58+
CRTPath = "/certs/certificate.pem"
59+
60+
61+
[Auth]
62+
Use = false
63+
Username = "user"
64+
Password = "pass"
65+
4866
[Credentials]
4967
ID = "<ID>"
5068
Secret = "<Secret>"
51-
Username = "<My-reddit-username>"
52-
Password = "<My-reddit-password>"
69+
Username = "<user>"
70+
Password = "<pass>"
5371

5472
[TemplateOptions]
5573
PrettyPrint = true

compactbro.sample.toml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
EcoMode = true
2+
MarkMsgsUnreadOnView = true
3+
CheckMsgs = true
4+
Logging = true
5+
DisplayFlairEmojis = true
6+
NightMode = false
7+
DefaultLimit = 25
8+
LocalAddress = "127.0.0.1:80"
9+
10+
[HTTPS]
11+
Use = true
12+
LocalAddress = "127.0.0.1:443"
13+
KeyPath = "/certs/key.pem"
14+
CRTPath = "/certs/certificate.pem"
15+
16+
17+
[Auth]
18+
Use = false
19+
Username = "user"
20+
Password = "pass"
21+
22+
[Credentials]
23+
ID = "<ID>"
24+
Secret = "<Secret>"
25+
Username = "<user>"
26+
Password = "<pass>"
27+
28+
[TemplateOptions]
29+
PrettyPrint = true
30+
LineNumbers = true

0 commit comments

Comments
 (0)