Browse Source

Add README

cryobry 3 years ago
parent
commit
ac9f99116d
1 changed files with 12 additions and 0 deletions
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -0,0 +1,12 @@
+Usage: 
+
+1. Configure user options in `install.sh`
+2. Run `./install.sh` as your normal user
+3. Confirm that user services are running and enabled: `systemctl --user status $service_name.service; systemctl --user status $service_name.timer`
+4. If errors occur, check journal output: `journalctl -r -u $service_name.service`
+
+Notes:
+
+1. curlftpfs doesn't support file permissions, thus we must only use -r in rsync
+2. curlftpfs doesn't support temporary files, thus the intermediate temp file step
+3. I mount the share to /media (by design so that my file manager will display it if it is erroneously mounted) but it may be easier for users to mount the ftp share somewhere in $HOME to avoid permissions issues