From 1b44dd10db560ec5eaf163bc131697bf2308a83b Mon Sep 17 00:00:00 2001 From: bartfaik04 Date: Sat, 7 Jun 2025 15:05:05 +0200 Subject: [PATCH] Update readme --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 2 deletions(-) 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 + + + + + + + + + + + + + + + + + + + + + + + + + +
NameRequiredDescription
NEXTCLOUD_CONTAINER_NAMEYesThe nextcloud's docker container name
NEXTCLOUD_USERSNoUsernames separated with spaces
NEXTCLOUD_GROUPFOLDER_IDSNoGroupfolder ids separated with spaces (only the number)
+ +Example 1: +``` +NEXTCLOUD_CONTAINER_NAME=nextcloud +``` +Example 2: (See `configs/ncsambawatcher.config.default`) + +5. Run the `init.sh` script +6. You're done :) + +## Notes + +- You don't need to add users and groupfolders to the configfile because the program add automaticly from the logfile +- For a user (not groupfolder): The username and the samba share name **MUST BE THE SAME**