Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
99darwin authored May 26, 2019
1 parent 6532f33 commit 5efe3f4
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,59 @@ We recommend a Raspberry Pi 3b+ device with a 64GB Class 10 microSD card. This i

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

# Filepaths

### Autostart Configuration

The autostart configuration can be found at `~/.config/lxsession/LXDE-pi/autostart`

* Scripts will be run at startup using the autostart file
* Always keep scripts above the `@xscreensaver -no-splash` line

### Divi Config Script (first run)

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:

* Prompts user for rpc username and writes to `~/.divi/divi.conf`
* Randomly generates an rpc password using the SHA256 hashing algorithm and writes it to `divi.conf`
* Renames `divisetup-run.sh` to `divisetup-complete.sh`
* Writes `daemon=1` to the `divi.conf` file

### Divi Config Script (subsequent runs)

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:

* Checks for `divisetup-complete.sh`
* If not found, runs `divisetup-run.sh`
* Runs the daemon

### Divi Shutdown Script

**Note: Shutdown script has not been confirmed as working and should be considered a known issue.**

# Aliases

Several bash aliases are present in the root directory's `.bash_aliases` file.

| ALIAS | FUNCTION |
| --- | --- |
| `aliasfile` | opens the alias file for editing |
| `reload` | reloads the shell |
| `init-divi-conf` | resets `divisetup-run.sh` to reconfigure `divid` on next boot |
| `dli` | alias for `./divi-cli`. Run any `divi-cli` command with `dli <command>` |
| `dividebug` | tails the debug log |
| `divistart` | starts `./divid` |
| `dividir` | quick access to the `DIVI` directory |
| `datadir` | quick access tho the Divi data directory where config files, etc. are found |



# FAQ

Q. Can I run a masternode on a Raspberry Pi?

A. Yes, see our [wiki page](https://wiki.diviproject.org/#masternode-setup-guide) for instructions.

Q. Can I use this Raspbian image as a "stake box?"

A. Yes, just be sure to back up your mnemonic seed phrase in case of SD card errors or any other issues.

0 comments on commit 5efe3f4

Please sign in to comment.