diff --git a/README.md b/README.md index 45c2174..66e2bb5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,57 @@ -# nextcloud-samba-sync +# Nextcloud-Samba Sync -A Nextcloud-Samba File scanner system \ No newline at end of file +## Pre installation + +- Install `samba` and `vfs-modules` +``` +sudo apt update +sudo apt install samba samba-vfs-modules +``` +- Create shares. The example is in `configs` folder + +## Installation + +1. Download a `ncsambawatcher.zip` file from a release above 2.0 +2. Extract somewhere on your server (I recommend your user folder) +3. Make sure the samba configuration file is correct (See `configs/smb.24.04.conf`) +4. Configurate the `ncsambawatcher.config` file +
| Name | +Required | +Description | +
NEXTCLOUD_CONTAINER_NAME |
+ Yes | +The nextcloud's docker container name | +
NEXTCLOUD_USERS |
+ No | +Usernames separated with spaces | +
NEXTCLOUD_GROUPFOLDER_IDS |
+ No | +Groupfolder ids separated with spaces (only the number) | +