-
Notifications
You must be signed in to change notification settings - Fork 490
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3877 from IQSS/3614-user-list
3614 user list
- Loading branch information
Showing
39 changed files
with
2,482 additions
and
143 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Maintenance | ||
=========== | ||
|
||
.. contents:: Contents: | ||
:local: | ||
|
||
When you have scheduled down time for your production servers, we provide a :download:`sample maintenance page <../_static/installation/files/etc/maintenance/maintenance.xhtml>` for you to use. To download, right-click and select "Save Link As". | ||
|
||
The maintenance page is intended to be a static page served by Apache to provide users with a nicer, more informative experience when the site is unavailable. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Monitoring | ||
=========== | ||
|
||
.. contents:: Contents: | ||
:local: | ||
|
||
In production you'll want to monitor the usual suspects such as CPU, memory, free disk space, etc. | ||
|
||
https://github.com/IQSS/dataverse/issues/2595 contains some information on enabling monitoring of Glassfish, which is disabled by default. | ||
|
||
There is a database table called ``actionlogrecord`` that captures events that may be of interest. See https://github.com/IQSS/dataverse/issues/2729 for more discussion around this table. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
Solr Search Index | ||
================= | ||
|
||
Dataverse requires Solr to be operational at all times. If you stop Solr, you should see a error about this on the home page, which is powered by the search index Solr provides. You can set up Solr by following the steps in our Installation Guide's :doc:`/installation/prerequisites` and :doc:`/installation/config` sections explaining how to configure it. This section you're reading now is about the care and feeding of the search index. PostgreSQL is the "source of truth" and the Dataverse application will copy data from PostgreSQL into Solr. For this reason, the search index can be rebuilt at any time. Depending on the amount of data you have, this can be a slow process. You are encouraged to experiment with production data to get a sense of how long a full reindexing will take. | ||
|
||
.. contents:: Contents: | ||
:local: | ||
|
||
Full Reindex | ||
------------- | ||
|
||
There are two ways to perform a full reindex of the Dataverse search index. Starting with a "clear" ensures a completely clean index but involves downtime. Reindexing in place doesn't involve downtime but does not ensure a completely clean index. | ||
|
||
Clear and Reindex | ||
+++++++++++++++++ | ||
|
||
Clearing Data from Solr | ||
~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Please note that the moment you issue this command, it will appear to end users looking at the home page that all data is gone! This is because the home page is powered by the search index. | ||
|
||
``curl http://localhost:8080/api/admin/index/clear`` | ||
|
||
Start Async Reindex | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
Please note that this operation may take hours depending on the amount of data in your system. This known issue is being tracked at https://github.com/IQSS/dataverse/issues/50 | ||
|
||
``curl http://localhost:8080/api/admin/index`` | ||
|
||
Reindex in Place | ||
+++++++++++++++++ | ||
|
||
An alternative to completely clearing the search index is to reindex in place. | ||
|
||
Clear Index Timestamps | ||
~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
``curl -X DELETE http://localhost:8080/api/admin/index/timestamps`` | ||
|
||
Start or Continue Async Reindex | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
If indexing stops, this command should pick up where it left off based on which index timestamps have been set, which is why we start by clearing these timestamps above. These timestamps are stored in the ``dvobject`` database table. | ||
|
||
``curl http://localhost:8080/api/admin/index/continue`` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
User Administration | ||
=================== | ||
|
||
This section focuses on user administration tools and tasks. | ||
|
||
.. contents:: Contents: | ||
:local: | ||
|
||
Manage Users Table | ||
------------------ | ||
|
||
The Manage Users table gives the network administrator a list of all user accounts in table form. It lists username, full name, email address, and whether or not the user has Superuser status. | ||
|
||
Usernames are listed alphabetically and clicking on a username takes you to the account page that contains detailed information on that account. | ||
|
||
You can access the Manage Users table by clicking the "Manage Users" button on the Dashboard, which is linked from the header of all Dataverse pages (if you're loggied in as an administrator). | ||
|
||
Confirm Email | ||
------------- | ||
|
||
Dataverse encourages builtin/local users to verify their email address upon signup or email change so that sysadmins can be assured that users can be contacted. | ||
|
||
The app will send a standard welcome email with a URL the user can click, which, when activated, will store a ``lastconfirmed`` timestamp in the ``authenticateduser`` table of the database. Any time this is "null" for a user (immediately after signup and/or changing of their Dataverse email address), their current email on file is considered to not be verified. The link that is sent expires after a time (the default is 24 hours), but this is configurable by a superuser via the ``:MinutesUntilConfirmEmailTokenExpires`` config option. | ||
|
||
Should users' URL token expire, they will see a "Verify Email" button on the account information page to send another URL. | ||
|
||
Sysadmins can determine which users have verified their email addresses by looking for the presence of the value ``emailLastConfirmed`` in the JSON output from listing users (see the "Admin" section of the :doc:`/api/native-api`). As mentioned in the :doc:`/user/account` section of the User Guide, the email addresses for Shibboleth users are re-confirmed on every login. | ||
|
||
Deleting an API Token | ||
--------------------- | ||
|
||
If an API token is compromised it should be deleted. Users can generate a new one for themselves as explained in the :doc:`/user/account` section of the User Guide, but you may want to preemptively delete tokens from the database. | ||
|
||
Using the API token 7ae33670-be21-491d-a244-008149856437 as an example: | ||
|
||
``delete from apitoken where tokenstring = '7ae33670-be21-491d-a244-008149856437';`` | ||
|
||
You should expect the output ``DELETE 1`` after issuing the command above. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 0 additions & 104 deletions
104
doc/sphinx-guides/source/installation/administration.rst
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.