Getting started

Getting started

After Part-DB you should begin with customizing the settings, and setting up the basic structures.

Customize config files

Click to expand

TODO

Change password, Set up Two-Factor-Authentication & Customize User settings

Click to expand

If you have not already done, you should change your user password. You can do this in the user settings (available in the navigation bar drop down with the user symbol).

There you can also find the option, to set up Two Factor Authentication methods like Google Authenticator. Using this is highly recommended (especially if you have admin permissions) to increase the security of your account. (Two Factor Authentication even can be enforced for all members of a user group)

In the user settings panel you can change account infos like your username, your first and last name (which will be shown alongside your username to identify you better), department information and your email address. The email address is used to send password reset mails, if your system is configured to use this.

In the configuration tab you can also override global settings, like your preferred UI language (which will automatically be applied after login), the timezone you are in (and in which times will be shown for you), your preferred currency (all money values will be shown converted to this to you, if possible) and the theme that should be used.

Create groups users and customize permissions

Click to expand

### Users When logged in as administrator, you can open the users menu in the `Tools` section of the sidebar under `System -> Users`. At this page you can create new users, change their passwords and settings and change their permissions. For each user which should use Part-DB you should setup a own account, so that tracking of what user did what works properly.

You should check the permissions for every user and ensure that they are in the intended way, and no user has more permissions than he needs. For each capability you can choose between allow, forbid and inherit. In the last case, the permission is determined by the group a user has (if no group is chosen, it equals forbid)

Anonymous user

The anonymous user is special, as its settings and permissions are used for everybody who is not logged in. By default the anonymous user has read capabilities for your parts. If your Part-DB instance is publicly available you maybe want to restrict the permissions.

Groups

If you have many users which should share the same permissions, it is useful to define the permissions using user groups, which you can create and edit in the System -> Groups menu.

By default 3 groups are defined:

• readonly which users have only have read permissions (like viewing, searching parts, attachments, etc.)
• users which users also have rights to edit/delete/create elements
• admin which users can do administrative operations (like creating new users, show global system log, etc.)

Users only use the setting of a capability from a group, if the user has a group associated and the capability on the user is set to inherit (which is the default if creating a new user). You can override the permissions settings of a group per user by explicitly settings the permission at the user.

Groups are organized as trees, meaning a group can have parent and child permissions and child groups can inherit permissions from their parents. To inherit the permissions from a parent group set the capability to inherit, otherwise set it explicitly to override the parents permission.

(Optional) Customize homepage banner

Click to expand

The banner which is shown on the homepage, can be customized/changed by changing the `config/banner.md` file with a text editor. You can use markdown and (safe) HTML here, to style and customize the banner. You can even use Latex style equations by wrapping the expressions into `$` (like `$E=mc^2$`, which is rendered inline: $E=mc^2$) or `$$` (like `$$E=mc^2$$`) which will be rendered as a block, like so: $$E=mc^2$$