diff --git a/README.md b/README.md index 2ae9e0e..3521aef 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ -This repo contains a docker-compose file for the following apps: +#### This repo contains a docker-compose file for the following apps: +(There may be files for apps not listed below but there will never be apps listed below without docker-compose files) + +All you will need to do is set a few variables. A few images (nextcloud, guacamole, owncloud) have individual id.env files included to set your passwords, etc. For the rest of the apps you will need to set three environmental variables which for most linux distrubutions can be done automatically with: +``` +export userid=$(id -u) +export groupid=$(id -g) +export time=$(cat /etc/timezone) +``` +to ensure it persists through reboot I usually do the following. Run these as your non-root user that youve added to the docker group: +``` +echo "export userid=$(id -u)" | tee -a ~/.bashrc +echo "export groupid=$(id -g)" | tee -a ~/.bashrc +echo "export time=$(cat /etc/timezone)" | ~/.bashrc +``` + +These files are preconfigured to run our media server under the /srv directory. Three subdirectories will be created: /srv/downloads, /srv/media, /srv/appdata. + +ll files should be easily customizable, if any of my preconfigured settings need to be personalized for your server. ## Media Servers @@ -111,4 +129,4 @@ editing and sharing files, calendars, address books and more. [Syncthing](http://forum.syncthing.net) Open Source Continuous File Synchronization. -[Resilio Sync](www.resilio.com) a proprietary peer-to-peer file synchronization tool. \ No newline at end of file +[Resilio Sync](www.resilio.com) a proprietary peer-to-peer file synchronization tool.