User Tools

Site Tools


en:user_advanced:gs3_user_management

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:user_advanced:gs3_user_management [2018/09/18 00:36] – [Greenstone 3 User Management] kjdonen: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 ======
  
Line 5: Line 8:
 (Note, The greenstone 2 version of this page can be found [[en:user_advanced:gs2_user_management|here]].) (Note, The greenstone 2 version of this page can be found [[en:user_advanced:gs2_user_management|here]].)
  
-TODO+The user DB (a derby database) can be found at greenstone3/web/etc/usersDB. 
-  Registering as a user + 
-  * User groups +===== User Registration ===== 
-  * Editing users+A user can register herself by visiting 
 +http://host:port/greenstone3/library/admin/Register 
 +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://host:port/greenstone3/library/admin/ListUsers, then clicking the 'Add A New User' button. 
 + 
 +===== 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\\ 
 +**<collname>-collection-editor** - the user can edit the <collname> collection\\ 
 + 
 +Bespoke groups can be added then used in security elements in individual collections, thereby restricting access to only subset of users. See the [[en:user_advanced:security| Security in Greenstone Collections]] page. 
 +===== 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:  **ant start-derby**. if Greenstone is running, then the derby server will be running. 
 + 
 +<code> 
 +java org.greenstone.gsdl3.util.ModifyUsersDB  
 +Usage: java org.greenstone.gsdl3.ModifyUsersDB <full_path_of_the_usersDB> <username|ALL> [-noAdd]  
 +[password=pwd] [groups=grp] [addgroups=grp] [accounstatus=status] [comment=cmt] [email=address] 
 +</code> 
 + 
 +(Options valid for releases from September 2021) 
 + 
 +Eg: To add a new user 
 +<code>java org.greenstone.gsdl3.ModifyUsersDB <path-to-greenstone3>/web/etc/usersDB kath password=changeme groups=student</code> 
 + 
 +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 'student' group to all users, run 
 + 
 +<code>java org.greenstone.gsdl3.ModifyUsersDB <path-to-greenstone3>/web/etc/usersDB ALL  addgroups=student</code> 
 + 
 +The **-noAdd** option will **not** create a new user if the specified username does not exist. 
 + 
 +==== Viewing and Editing the database via a text file ==== 
 + 
 +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, and make sure the derby server is running. 
 + 
 +They are run like: 
 +<code> 
 +java org.greenstone.gsdl3.util.usersDB2txt <path-to-gs3>/web/etc/usersDB >& usersDB.txt 
 + 
 +... edit the file if necessary, then regenerate the DB: 
 + 
 +java org.greenstone.gsdl3.util.txt2usersDB usersDB.txt <path-to-gs3>/web/etc/usersDB [-append] 
 +</code> 
 +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 ====
Line 21: Line 82:
 </code> </code>
  
-By default, Greenstone is setup to use the recaptcha test for the "register" and "adduser" operations. If you would like to add it to other operations (or remove it from the current ones) please edit the operations recaptcha element in siteConfig.xml:+By default, Greenstone is set up to use the recaptcha test for the "register" and "adduser" operations. If you would like to add it to other operations (or remove it from the current ones) please edit the operations recaptcha element in siteConfig.xml:
 <code> <code>
 <!-- edit this list to specify which operations use the recaptcha test--> <!-- edit this list to specify which operations use the recaptcha test-->
Line 27: Line 88:
 <recaptcha name="operations" value="Register,AddUser"/> <recaptcha name="operations" value="Register,AddUser"/>
 </code> </code>
 +
 +Note: please restart Tomcat for these changes to take effect.
 === Disabling Recaptcha in earlier versions of Greenstone === === Disabling Recaptcha in earlier versions of Greenstone ===
  
Line 83: Line 146:
 </init-param> </init-param>
 </code> </code>
- 
  
en/user_advanced/gs3_user_management.1537230972.txt.gz · Last modified: 2018/09/18 00:36 by kjdon