mirror/Part-DB.Part-DB-server
1
0
Fork 1
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2025-08-31 07:09:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Document system settings in getting_started guide

Browse source
This commit is contained in:
Jan Böhmer 2025-08-29 23:33:35 +02:00
parent d5c5c7c772
commit e3125e3afb
2 changed files with 15 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/assets/getting_started/system_settings.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 49 KiB

22
docs/usage/getting_started.md
View file

@ -12,11 +12,19 @@ Before starting, it's useful to read a bit about the [concepts of Part-DB]({% li
1. TOC 1. TOC
{:toc} {:toc}
## Customize config files ## Customize system settings
Before you start creating data structures, you should configure Part-DB to your needs by changing possible configuration Before starting creating datastructures, you should check the system settings to ensure that they fit your needs.
options. After login as an administrator, you can find the settings in the sidebar under `Tools -> System -> Settings`.
This is done either via changing the `.env.local` file in a direct installation or by changing the env variables in ![image]({% link assets/getting_started/system_settings.png %})
Here you can change various settings, like the name of your Part-DB instance (which is shown in the title bar of the
browser), the default language (which is used if no user preference is set), the default timezone (which is used to
display times correctly), the default currency (which is used to display prices correctly), and many more.
Some more fundamental settings like database connection, mail server settings, SSO, etc. are configured via environment variables.
Environment variables also allow to overwrite various settings from the web interface.
Environment variables can be changed by editing the `.env.local` file in a direct installation or by changing the env variables in
your `docker-compose.yaml` file. your `docker-compose.yaml` file.
A list of possible configuration options can be found [here]({% link configuration.md %}). A list of possible configuration options can be found [here]({% link configuration.md %}).
@ -44,8 +52,8 @@ used.
## (Optional) Customize homepage banner ## (Optional) Customize homepage banner
The banner which is shown on the homepage, can be customized/changed by changing the `config/banner.md` file with a text The banner which is shown on the homepage, can be customized/changed via the homepage banner setting in system settings.
editor. You can use markdown and (safe) HTML here, to style and customize the banner. 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: 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$$ $E=mc^2$) or `$$` (like `$$E=mc^2$$`) which will be rendered as a block, like so: $$E=mc^2$$
@ -202,4 +210,4 @@ later.
You can choose from your created datastructures to add manufacturer information, supplier information, etc. to the part. You can choose from your created datastructures to add manufacturer information, supplier information, etc. to the part.
You can also create new datastructures on the fly, if you want to add additional information to the part, by typing the You can also create new datastructures on the fly, if you want to add additional information to the part, by typing the
name of the new datastructure in the field and select the "New ..." option in the dropdown menu. See [tips]({% link name of the new datastructure in the field and select the "New ..." option in the dropdown menu. See [tips]({% link
usage/tips_tricks.md %}) for more information. usage/tips_tricks.md %}) for more information.