en:user_advanced:gs3_user_management
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:user_advanced:gs3_user_management [2018/08/27 02:27] – [Setting up the Recaptcha test for User Registration] kjdon | en:user_advanced:gs3_user_management [2023/03/13 01:46] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | |||
+ | |||
+ | |||
====== Greenstone 3 User Management ====== | ====== Greenstone 3 User Management ====== | ||
- | Greenstone software comes equipped with a system for registering and administering users. Greenstone users can register as a user with a login and password. Administrators can then assign them into various groups. These user groups are used for authenticating login to a [[en: | + | Greenstone software comes equipped with a system for registering and administering users. Greenstone users can register as a user with a login and password. Administrators can then assign them into various groups. These user groups are used for authenticating login to a [[en: |
(Note, The greenstone 2 version of this page can be found [[en: | (Note, The greenstone 2 version of this page can be found [[en: | ||
- | TODO: | + | The user DB (a derby database) can be found at greenstone3/ |
- | * Registering as a user | + | |
- | * User groups | + | ===== User Registration ===== |
- | * Editing | + | A user can register herself by visiting |
+ | http://host:port/ | ||
+ | This is linked to near the bottom of the default library home page. | ||
+ | |||
+ | Admin can register a new user by visiting the admin page: http:// | ||
+ | |||
+ | ===== User Groups ===== | ||
+ | |||
+ | Groups are used to determine what functionality a user is provided. Multiple groups are specified in a comma-separated list. | ||
+ | |||
+ | **administrator** - can do user management\\ | ||
+ | **all-collections-editor** - can edit any collection (through web editing or through remote GLI)\\ | ||
+ | **personal-collections-editor** - the user can create their own collections and edit them\\ | ||
+ | **< | ||
+ | |||
+ | Bespoke groups can be added then used in security elements in individual collections, | ||
+ | ===== Command line editing of users ===== | ||
+ | |||
+ | **ant config-admin** - reset the admin password\\ | ||
+ | **ant config-user** - add or edit users. This requires you to provide all user fields: username, password, groups, status, comment, email. They can be left blank, but it will override any previous values in the db. | ||
+ | |||
+ | Or you can directly use the java class.\\ | ||
+ | Make sure you have set up the Greenstone environment by running **source gs3-setup.sh** (linux/Mac) or **gs3-setup.bat** (windows). Also, start the derby server if its not already running: | ||
+ | |||
+ | < | ||
+ | java org.greenstone.gsdl3.util.ModifyUsersDB | ||
+ | Usage: java org.greenstone.gsdl3.ModifyUsersDB < | ||
+ | [password=pwd] [groups=grp] [addgroups=grp] [accounstatus=status] [comment=cmt] [email=address] | ||
+ | </ | ||
+ | |||
+ | (Options valid for releases from September 2021) | ||
+ | |||
+ | Eg: To add a new user | ||
+ | < | ||
+ | |||
+ | The **groups** option will set the group field to the specified value.\\ | ||
+ | The **addgroups** option will add the specified groups to whatever groups exist already (if editing an existing user) | ||
+ | |||
+ | Using username **ALL** will perform the selected changes on all users.\\ | ||
+ | For example, to add the ' | ||
+ | |||
+ | < | ||
+ | |||
+ | The **-noAdd** option will **not** create a new user if the specified username does not exist. | ||
+ | |||
+ | ==== Viewing and Editing | ||
+ | |||
+ | There are 2 java programs which help you view and edit the database: usersDB2txt and txt2usersDB | ||
+ | As above, you must set up the greenstone environment, | ||
+ | |||
+ | They are run like: | ||
+ | < | ||
+ | java org.greenstone.gsdl3.util.usersDB2txt < | ||
+ | |||
+ | ... edit the file if necessary, then regenerate the DB: | ||
+ | |||
+ | java org.greenstone.gsdl3.util.txt2usersDB usersDB.txt < | ||
+ | </ | ||
+ | The **-append** option means append the contents of the file into the DB. Without it, the current contents will be deleted. | ||
==== Setting up the Recaptcha test for User Registration ==== | ==== Setting up the Recaptcha test for User Registration ==== | ||
- | **NOTE:** this applies to greenstone | + | **NOTE:** this applies to Greenstone |
- | Greenstone 3 is set up to use Recaptcha for authenticating users when they are registering. | + | Greenstone 3 is set up to use Recaptcha for authenticating users when they are registering. |
- | Prior to 3.09 it used version 1 of recaptcha, which is no longer supported by Google. If you have an older Greenstone, you will not be able to use recaptcha any more. Please | + | < |
+ | < | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | By default, Greenstone is set up to use the recaptcha test for the " | ||
+ | < | ||
+ | <!-- edit this list to specify which operations use the recaptcha test--> | ||
+ | <!-- valid operations include Register, AddUser, Login, --> | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | Note: please restart Tomcat for these changes to take effect. | ||
+ | === Disabling Recaptcha in earlier versions of Greenstone === | ||
+ | |||
+ | Prior to 3.09 Greenstone | ||
< | < | ||
< | < | ||
Line 70: | Line 146: | ||
</ | </ | ||
</ | </ | ||
- | |||
en/user_advanced/gs3_user_management.1535336847.txt.gz · Last modified: 2018/08/27 02:27 by kjdon