forked from medplum/medplum
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added super admin guide (medplum#1554)
- Loading branch information
1 parent
32a758a
commit d9ce20c
Showing
5 changed files
with
104 additions
and
17 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,56 @@ | ||
--- | ||
sidebar_position: 6 | ||
--- | ||
|
||
# Super Admin Guide | ||
|
||
When self-hosting a Medplum server, you will have access to a "Super Admin" project. When you sign in as a member of the "Super Admin" project, you will have access to very powerful super admin privileges. | ||
|
||
:::danger | ||
|
||
Super admin features can cause unrepairable damage. Proceed with caution. With great power comes great responsibility! | ||
|
||
::: | ||
|
||
## Protected Resources | ||
|
||
Medplum uses custom FHIR resource types to manage user accounts and project administration. While these are not official FHIR resources, Medplum uses the same FHIR semantics: the same RESTful operations, same search capabilities, `StructureDefinition` resources, `SearchParameter` resources, etc. | ||
|
||
The most important custom resource types are: | ||
|
||
- `User` - represents a user account capabale of logging into the system | ||
- `Project` - represents a project which contains other resources | ||
- `ProjectMembership` - link between a `User` and a `Project` which also defines `AccessPolicy` and `UserConfiguration` | ||
- `Login` - an authentication event and session state | ||
|
||
## Server Maintenance | ||
|
||
From time to time, you may need to perform system level maintenance. The Medplum app has a special "Super Admin" page to make it easier to perform these tasks. You can find the "Super Admin" page at `/admin/super`. | ||
|
||
:::note | ||
|
||
In the future, we hope that most of this maintenance will be 100% automatic and behind the scenes. For now, it is important that you understand this maintenance for system health. | ||
|
||
::: | ||
|
||
### Rebuild Resources | ||
|
||
In the "Super Admin" page, there are buttons and sections for: | ||
|
||
- Rebuild Structure Definitions | ||
- Rebuild Search Paramters | ||
- Rebuild Value Sets | ||
|
||
From time to time, Medplum will make changes to custom resources. The server runtime uses `StructureDefinition` and `SearchParameter` files directly from disk. However, the client requests `StructureDefinition` resources to dynamically generate client-side UI elements such as search filters, the "Details" page, and the "Edit" page. If a Medplum changes these resources, you may need to rebuild the index before you see the changes in the client. | ||
|
||
### Reindex Resources | ||
|
||
From time to time, Medplum makes changes to the underlying search indexing logic. This usually happens when adding support for new FHIR search capabilities. Resource indexes are updated automatically on every `create` or `update` operation. Use the "Reindex Resources" button to reindex existing resources. | ||
|
||
### Purge Resources | ||
|
||
Some system generated resources can accumulate and lead to degraded performance. Use the "Purge Resources" form to permanently delete resources from the database. Note that this operation is a true `DELETE`, and not the normal "soft delete", so this is permanent. Medplum recommends backing up all data, or synchronizing data to a data warehouse before using this feature. | ||
|
||
### Force Set Password | ||
|
||
User accounts are global, and can be members of multiple projects. Therefore, normal project administrators do not have access to "Set Password" functionality. Use the "Force Set Password" button to forcefully override a user's password. |
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 |
---|---|---|
@@ -1,5 +1,2 @@ | ||
CREATE DATABASE medplum_test; | ||
GRANT ALL PRIVILEGES ON DATABASE medplum_test TO medplum; | ||
\c medplum_test; | ||
CREATE EXTENSION "uuid-ossp"; | ||
\c medplum; |