Skip to content

Commit 5efe3f4

Browse files
authored
Update README.md
1 parent 6532f33 commit 5efe3f4

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,59 @@ We recommend a Raspberry Pi 3b+ device with a 64GB Class 10 microSD card. This i
1515

1616
For more information on CLI commands, see our [wiki page](https://wiki.diviproject.org/#divi-cli)
1717

18+
# Filepaths
19+
20+
### Autostart Configuration
21+
22+
The autostart configuration can be found at `~/.config/lxsession/LXDE-pi/autostart`
23+
24+
* Scripts will be run at startup using the autostart file
25+
* Always keep scripts above the `@xscreensaver -no-splash` line
26+
27+
### Divi Config Script (first run)
28+
29+
A script called `divisetup-run.sh` will run the first time the image is booted. It is located at `/home/pi/divisetup-run.sh` and performs the following actions:
30+
31+
* Prompts user for rpc username and writes to `~/.divi/divi.conf`
32+
* Randomly generates an rpc password using the SHA256 hashing algorithm and writes it to `divi.conf`
33+
* Renames `divisetup-run.sh` to `divisetup-complete.sh`
34+
* Writes `daemon=1` to the `divi.conf` file
35+
36+
### Divi Config Script (subsequent runs)
37+
38+
After the initial setup, a script named `divi-startup.sh` runs on boot. It is located at `/home/pi/divi-startup.sh` and performs the following actions:
39+
40+
* Checks for `divisetup-complete.sh`
41+
* If not found, runs `divisetup-run.sh`
42+
* Runs the daemon
43+
44+
### Divi Shutdown Script
45+
46+
**Note: Shutdown script has not been confirmed as working and should be considered a known issue.**
47+
48+
# Aliases
49+
50+
Several bash aliases are present in the root directory's `.bash_aliases` file.
51+
52+
| ALIAS | FUNCTION |
53+
| --- | --- |
54+
| `aliasfile` | opens the alias file for editing |
55+
| `reload` | reloads the shell |
56+
| `init-divi-conf` | resets `divisetup-run.sh` to reconfigure `divid` on next boot |
57+
| `dli` | alias for `./divi-cli`. Run any `divi-cli` command with `dli <command>` |
58+
| `dividebug` | tails the debug log |
59+
| `divistart` | starts `./divid` |
60+
| `dividir` | quick access to the `DIVI` directory |
61+
| `datadir` | quick access tho the Divi data directory where config files, etc. are found |
62+
63+
64+
1865
# FAQ
66+
1967
Q. Can I run a masternode on a Raspberry Pi?
68+
2069
A. Yes, see our [wiki page](https://wiki.diviproject.org/#masternode-setup-guide) for instructions.
2170

2271
Q. Can I use this Raspbian image as a "stake box?"
72+
2373
A. Yes, just be sure to back up your mnemonic seed phrase in case of SD card errors or any other issues.

0 commit comments

Comments
 (0)