en:user:authentication
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:user:authentication [2018/08/27 00:14] – [Authentication in Greenstone] kjdon | en:user:authentication [2023/03/13 01:46] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | |||
+ | |||
+ | |||
====== Authentication in Greenstone ====== | ====== Authentication in Greenstone ====== | ||
The Greenstone software comes equipped with an authentication system. Users can " | The Greenstone software comes equipped with an authentication system. Users can " | ||
Line 4: | Line 7: | ||
A special type of user called an " | A special type of user called an " | ||
- | <TABAREA tabs=" | ||
- | <TAB> | ||
- | To access this facility, click the **Login** button in the | ||
- | upper right corner of the interface and enter your username and password (the default is " | ||
- | and " | ||
For more information on security in Greenstone 3, refer to [[http:// | For more information on security in Greenstone 3, refer to [[http:// | ||
- | </ | ||
- | <!-- #################################################################################################### | ||
- | #################################################################################################### | ||
- | ################################################################################ | ||
- | <TAB> | ||
- | <!-- id:582 -->To access this facility, click the appropriate link on the front page. | ||
- | <!-- id:583 -->The entry page gives information about each of the collections offered by the system. | ||
- | Note that //all// collections are included—for there may be “private” ones that do not appear on the | ||
- | Greenstone home page. With each is given its short name, full name, whether it is publicly displayed, | ||
- | and whether or not it is running. Clicking a particular collection' | ||
- | that collection, gathered from its collection configuration file and from other internal | ||
- | | ||
- | clicking the collection' | ||
- | <!-- id:585 -->The administrative facility also presents configuration information about | ||
- | the installation and allows it to be modified. It facilitates examination of the error | ||
- | logs that record internal errors, and the user logs that record usage. It enables a | ||
- | specified user (or users) to authorize others to build collections and add new material | ||
- | to existing ones. | ||
- | ===== <!-- id:599 -->User management ===== | ||
- | <!-- id:600 --> | + | =====User management ===== |
- | access to certain facilities. This is used to restrict the people | + | |
- | who are allowed to access certain administration pages and allow for private collections/ | + | |
- | Authentication | + | Greenstone' |
- | <!-- id:601 -->From the administration page users can be listed, | + | Authentication |
- | new ones added, and old ones deleted. | + | |
- | The ability to do this is of course also protected: | + | |
- | only users who have administrative privileges can add new users. | + | |
- | | + | |
- | At present, the only extant groups are “administrator” and “colbuilder”. | + | |
- | Members of the first group can add and remove users, and change their groups. | + | |
- | | + | |
- | collections and alter (and delete) existing ones. | + | |
- | <!-- id:602 -->When Greenstone is installed, there is one user called //admin// who belongs | + | The current list of predefined groups |
- | to both groups. | + | |
- | did not set a password during installation, | + | |
- | username = //admin//, password = //admin//). | + | |
- | This user can create new names and passwords for users who belong just to the | + | |
- | // | + | |
- | to build collections. User information | + | |
- | the Greenstone file structure (see the // | + | |
- | =====Forgotten Password===== | + | |
- | (With instructions by Diego Spano.) | + | ***personal-collections-editor**: |
+ | * **< | ||
+ | * **all-collections-editor**: | ||
- | User account details are stored in etc/ | + | In addition, any custom group name can be used. |
- | There are several ways in which to reset your admin account' | + | When Greenstone is installed, there is one user called //admin// who belongs |
+ | to both the administrator and all-collections-editor groups. The password for this user is set during the installation process (If you | ||
+ | did not set a password during installation, | ||
+ | username = //admin//, password | ||
- | **Option 1** | + | For more details about user management, see the appropriate page for your Greenstone: |
+ | | ||
+ | | ||
- | In greenstone/ | + | ===== Collection Security ===== |
- | Do the following: | + | Collections can be made public or private. Additionally they can be password protected so that only users who belong to specified groups can access them. Or collections can be public with the exception of a few specified documents in that colleciton, which require a username and password to access. |
- | 1. Create a text file named myusers.csv and add the following line inside: | + | See the [[en:user_advanced: |
- | < | + | |
- | 2. open a terminal | + | ===== Additional features ===== |
- | 3. move to Greenstone root folder. | + | Once you have authenticated users, you can use features such as: |
+ | * [[en: | ||
+ | * [[en: | ||
- | 4. Run setup.bat (Windows) or setup.bash | ||
- | 5. Run "perl -S csv-usernames-to-db.pl / | ||
- | With this script you will create a user named Tom, with password " | ||
- | |||
- | **Option 2** | ||
- | |||
- | 1. If you're admin, then open a terminal. To set the admin password on Linux, you can run: | ||
- | < | ||
- | and on Windows: | ||
- | < | ||
- | |||
- | 2. If your admin account is working fine, then make sure you've enabled the Administration pages. You can do this by opening etc/ | ||
- | < | ||
- | to | ||
- | < | ||
- | |||
- | 3. Go to your Greenstone home page, click on the // | ||
- | |||
- | 4. Login with the admin account. Then select the user whose password you want to reset by pressing the Edit button and filling in the new details. | ||
- | |||
- | **Option 3** | ||
- | |||
- | Delete the file greenstone/ | ||
- | |||
- | |||
- | =====Password Protection===== | ||
- | |||
- | ==== Private Collections ==== | ||
- | This feature is not currently available through the Librarian Interface. Please close the collection if it is open in the Librarian Interface. Edit the GSDLHOME/ | ||
- | |||
- | | ||
- | | ||
- | |||
- | You may have to restart the Greenstone server for the changes to take effect. | ||
- | |||
- | The **auth_groups** line specifies the user group(s) which have access to the documents. To access a protected collection, a person must have a user name and password, and this user name must belong to one of the specified groups. See below for how to add new users and set their groups. | ||
- | |||
- | **IMPORTANT NOTE:** In Greenstone 2.82 and earlier, use **auth_group** instead of auth_groups (both will still be recognised in later Greenstone versions). | ||
- | ==== Private Documents ==== | ||
- | |||
- | It is possible to password-protect specific documents in your collection. | ||
- | This feature is not currently available through the Librarian Interface. Please close the collection if it is open in the Librarian Interface. Edit the GSDLHOME/ | ||
- | |||
- | | ||
- | | ||
- | |||
- | The **auth_groups** line specifies the user group(s) which have access to the documents. To access a protected collection, a person must have a user name and password, and this user name must belong to one of the specified groups. See below for how to add new users and set their groups. | ||
- | |||
- | **IMPORTANT NOTE:** In Greenstone 2.82 and earlier, use **auth_group** instead of auth_groups (both will still be recognised in later Greenstone versions). | ||
- | |||
- | Then add **either** of the following two lines: | ||
- | | ||
- | | ||
- | |||
- | These two lines specify a list of document identifiers (ex.Identifier in the Enrich pane). Using **private_documents**, | ||
- | |||
- | |||
- | =====Creating a new user===== | ||
- | |||
- | You need to use the administration facility. You can access the administration page by clicking the **Administration Page** button on the home page of your Greenstone installation. If this is not present, enable it by setting **status** to **enabled** in the GSDLHOME/ | ||
- | |||
- | From the administration page you can list users and add new users by clicking the links down the left hand side of the page. You will need to use the admin account that was set up when you installed Greenstone. | ||
- | |||
- | You can change the properties of an existing user by clicking the edit link from the list users page. | ||
- | |||
- | If you are adding users to access a protected collection, make sure you add the required group into the groups field. | ||
- | |||
- | |||
- | |||
- | =====Usage information===== | ||
- | |||
- | You can enable usage logging by setting the logcgiargs option to true in greenstone/ | ||
- | |||
- | You can find out what the cgi arguments mean by going to the Administration page of your Greenstone installation, | ||
- | |||
- | ===== User Comments ===== | ||
- | |||
- | If you enable comments for your library, library users with accounts are able to add comments | ||
- | to the document pages of collections. | ||
- | |||
- | To allow users to view and add comments to documents: | ||
- | - In the Format Features section of the Format pane of GLI, go to the Choose Feature dropdown and select AllowUserComments. | ||
- | - Press the Add Format button to add this to the list of active Format Features for your collection. | ||
- | - Select the AllowUserComments option that is now in the list and then tick its Enabled button to activate it. | ||
- | - Press the Preview button and visit a document of your collection. | ||
- | It should now provide a small "Add comment" | ||
Line 173: | Line 57: | ||
* The [[http:// | * The [[http:// | ||
- | |||
- | </ | ||
en/user/authentication.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1