Create Wiki & Related Docs

[sameleff]

This will be an ongoing effort, but this issue attempts to capture the need for documentation to cover several common setup & troubleshooting steps for both the player and the streamer.

Suggested Outline:

1. Streamer
   A. Initial Setup
   B. Usage
   C. Steps to Update
   D. Troubleshooting / Common Fixes
2. Player
   A. Initial Setup
   B. Usage
   C. Steps to Update
   D. Troubleshooting / Common Fixes

[thomaseleff]

We can create a new sub-folder within the docs directory, called developer which can contain the README.md or docs for setting up / running locally.

[sameleff]

What do you think about enabling the Wiki feature and using that? Then we can create an outline with header topics like installation, streamer usage, player usage, etc.

[thomaseleff]

Hmm @sameleff I think creating a README.md is the easiest (least effort to maintain), I imagine these docs will change quite a bit as the codebase evolves.

For example, I think the "How it works" doc is already out of date...

[sameleff]

@EeffJleff Capturing some helpful points that can be included in your docs!

Where are config files located?

1. The PI itself: enter the command dietpi-config.
2. Audera: from the root directory, enter the command cd .audera.
3. Airplay: from the root directory, enter the command cd .. then cd usr/local/etc.

How to update the hostname after initial config?
There are three potential hostnames to update:

1. The RPI itself. Navigate to Security Options from the dietpi-config, then modify the hostname as desired; reboot the PI.
2. Audera. Modify the identity.json file within the audera config folder; reboot the PI.
3. Airplay. Modify the shairport-sync.conf file within the airplay config directory; reboot the PI.

How to SSH into the PI?
Using your preferred SSH / Telnet client (e.g. PuTTY), connect to the PI via its local IP address and port 22. The username is root and the password is audera.