Managing server with web UI
Only administrator users have access to the administration UI. The page is currently usable for inspecting the server status and to check that documents are being processed properly. In addition, administrators can schedule additional processing for documents. Indiviual documents can be scheduled along with scheduling all documents for a specific user.
The admin UI shows:
- general server info
- runtime information and search engine status
- server statistics
- list of users
- document processing queue
Scheduling documents for processing
If there’s ever a reason to force processing documents, administrator can schedule specific processing steps for given document or user. Reasons for re-processing may be for instance:
- Document’s content extraction failed for some reason
- User wants to re-run the rules again
- Search index does not work or is outdated
The steps are consecutive in nature, meaning that e.g. full-text-search indexing should always be the last step to do. For example, if step ‘content’ is scheduled, then ‘rules’ and ‘fts’ scheduled too. Virtualpaper server schedules required steps automatically. Please see How does Virtualpaper work for an overview of the processing works.
To schedule processing for a single document, enter the document id and the starting step. To schedule processing for all documents of a single user, set the user id and the starting step.
List of processing steps
| Order | Id | Name | Description |
|---|---|---|---|
| 1. | thumbnail | Thumbnail | Generates document thumbnail (.png) |
| 2. | content | Extract content | Attempts to extract the content from PDF or image files |
| 3. | rules | User rules | Executes user-defined processing rules |
| 4. | fts | Search index | Indexes the document to the search index |
Updating search index
Sometimes it is necessary to update the search index inside Meilisearch instance. Reasons for this may be:
- clearly incorrect search results (should not happen, but this may help)
- after backup is restored and fresh Meilisearch instance is used
- Meilisearch prior to v1 is upgraded, since Meilisearch does not yet support easy migrations
The process to fully re-build index is for one user is:
- fill the user id
- set step as ‘fts’
- execute
When there’s many users in the system, this process can become tedious. At the moment the easiest way to schedule for many users is with the CLI. For few users the admin ui is still probalby easiest way to manually index all documents.
Manage users
Administrators can create new and edit existing users from the administration panel. Users can be promoted as administrator and activated & deactivated as well. Also it is possible to reset user’s password.