README.md

About nc-userimporter

This tool creates Nextcloud users from a CSV file, which you exported from some other software or created with a spreadsheet software.

Zip file with an executable for Windows is available here: https://get.edudocs.org/de/assets/nc-userimporter/ - If you have a Python3 environment with all the dependencies/modules installed, you can run the script without the build of course.

Screenshot input:

Instructions

1. Download and extract the zip-file from https://get.edudocs.org/de/assets/nc-userimporter/

2. Insert data:

   • config.xml: Insert your cloud-admin credentials into file config.xml. The user must have admin permissions in your Nextcloud.
   • users.csv: Insert the user data into the file users.csv or recreate it with the same columns in a spreadsheet software.

3. Start the tool:

   • Windows: doubleclick nc-userimporter.exe.
   • Linux / Mac: install all dependencies (https://github.com/t-markmann/nc-userimporter/wiki#install-dependencies-for-running-py-script) and run: python3 nc-userimporter.py
     • Troubleshooting: Make sure the file is executable (https://www.qwant.com/?q=make%20file%20executable%20linux / https://www.qwant.com/?q=make%20file%20executable%20mac)

4. Follow the interactive commandline instructions. Check output.log ("output"-folder in script-directory) and your user overview in Nextcloud.

Output

Screenshot output:

---

ToDo

• improve documentation of features https://github.com/t-markmann/nc-userimporter/wiki#todo-documentation
• refactoring / clean code

Open features, not yet implemented (help appreciated):

• read config from CLI-input if config-file is empty; update config.xml with input values?
• ask if users exists first: https://docs.nextcloud.com/server/15/admin_manual/configuration_user/instruction_set_for_users.html
• add other userdata
• delete users