Skip to content

Commit

Permalink
Update system admin guie (#16506)
Browse files Browse the repository at this point in the history
  • Loading branch information
MayaBerd authored Aug 22, 2024
1 parent eb98b08 commit 3a0942d
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 6 deletions.
16 changes: 11 additions & 5 deletions docs/system-admin-guide/backup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,25 @@ Unless disabled via the [configuration](../../installation-and-operations/config

You can yourself create backups of your OpenProject installation. Go to *Administration* and *Backup* to get started.

![administration-backup](administration-backup-2034314.png)

To be able to create a backup, a so called _backup token_ has to be generated first. This is supposed to add another level of security since backing up the whole installation includes sensitive data.

You will then need to create a backup token by clicking **+ Backup token**.

![create-backup-token](create-backup-token.png)
![Create a backup token in OpenProject administration](openproject_system_guide_backup_tocken.png)

You will be asked to enter **create** to confirm that you wish to create a token.

![Confirm creating a backup token in OpenProject](openproject_system_guide_backup_token_confirm.png)

In the next step you will be asked to confirm your password.

You will be asked to confirm your password when you try to generate or reset a token. The _backup token_ will only be displayed once after it has been generated. Make sure you store it in a safe place.
> [!IMPORTANT]
>
> The _backup token_ will only be displayed **once** after it has been generated. Make sure you store it in a safe place.
The system generates the token which you then fill in where requested in the field below. Then you can press the **Request backup** button

![backup-code](backup-code.png)
![Success backup token generation message in OpenProject](openproject_system_guide_backup_token_success.png)

Each time you request a backup this token has to be provided. This also applies when requesting a backup via the API where on top of the API token the _backup token_ will have to be provided as well.

Expand Down
Binary file not shown.
Binary file removed docs/system-admin-guide/backup/backup-code.png
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/system-admin-guide/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Aside from uploading logos and icons, you can also customize the colors used wit
To do this change the color values (entered as color hex code) in the *Advanced settings* section. In order to find the right hex code for a color, you can use a website, such as [color-hex.com](https://www.color-hex.com/).
You can see the selected color in the preview area next to the color hex code. Therefore, it is possible to see the selected color before saving the changes.

> ![TIP]
> [!TIP]
> If the button color you select is too light to have white text on top of it, the icon and text color will be displayed in black instead.
![Advanced color settings in OpenProject](openproject_system_guide_design_advanced_settings_primer.png)
Expand Down

0 comments on commit 3a0942d

Please sign in to comment.