Jan Böhmer
4102086803
Do not put the initial admin key env into the docker compose templates
...
This is an feature for advanced users only and will risk secret leaking
2025-09-23 20:21:56 +02:00
Ryan Malloy
f9e7fb4491
Merge branch 'Part-DB:master' into feature/initial-admin-api-key
2025-09-07 10:09:53 -06:00
Ryan Malloy
99cd18096b
Add INITIAL_ADMIN_API_KEY documentation
...
- Document environment variable in configuration.md
- Add section to API authentication documentation
- Include examples in Docker installation guide for both SQLite and MySQL setups
- Provide usage instructions for CI/CD and automated deployments
2025-09-07 08:42:17 -06:00
d-buchmann
7f099972e1
Documentation - Require SQLite 3.35
...
That way, migrations that try to drop columns won't fail anymore (regardless if the user intended to use sqlite or not)
2025-09-04 14:50:59 +02:00
Jan Böhmer
6d495b38b4
Removed env vars from docker-compose example
2025-08-30 21:48:42 +02:00
Jan Böhmer
ab811b1b7b
Updated debian installation guide
Build assets artifact / Build assets artifact (push) Waiting to run
Docker Image Build / docker (push) Waiting to run
Docker Image Build (FrankenPHP) / docker (push) Waiting to run
Static analysis / Static analysis (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.2, mysql) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.3, mysql) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.4, mysql) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.2, postgres) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.3, postgres) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.4, postgres) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.2, sqlite) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.3, sqlite) (push) Waiting to run
PHPUnit Tests / PHPUnit and coverage Test (PHP 8.4, sqlite) (push) Waiting to run
2025-08-29 00:12:01 +02:00
Jan Böhmer
8c22ec46bc
Require nodejs 20.0 or later
2025-08-03 20:44:45 +02:00
Jan Böhmer
2b694731ad
Added content-security policy for SVG files in webserver config
2025-05-18 20:38:53 +02:00
Jan Böhmer
c8375def1a
Added an database automigration feature to the docker image
2025-03-30 14:47:48 +02:00
Jan Böhmer
616aad6403
Added hint to docker install docs, that you need to run sudo with -E command
...
That should prevent isssues like in #882 and #871
2025-03-07 11:29:58 +01:00
Nico Felbinger
8f0f5a5eb4
Fix postgresl unix socket example ( #852 )
...
* Fix postgresl unix socket example
* Fix user defaulting to root
2025-02-02 21:09:10 +01:00
Jan Böhmer
04a0369d56
Added proxmox LXC installation method to docs
2024-12-25 19:21:30 +01:00
Jan Böhmer
31a288b44d
Added recommendation on installation methods
2024-12-25 19:13:28 +01:00
Jan Böhmer
502dc3aa1c
Added kubernetes as available installation method.
2024-12-25 19:12:09 +01:00
Jan Böhmer
abb5395cae
Use "log-bin-trust-function-creators" option for mysql in recommended docker-compose file
...
This avoids errors, while creating the MySQL functions for the natural sort: "1419 You do not have the SUPER privilege an
d binary logging is enabled"
2024-09-08 19:46:55 +02:00
Jan Böhmer
1f6e3db09e
Document natural sorting and the DATABASE_EMULATE_NATURAL_SORT option
2024-06-21 12:31:25 +02:00
Jan Böhmer
2fabcabcc0
Added documentation about the different DATABASE_URL formats for the database types
2024-06-21 11:58:09 +02:00
Jan Böhmer
22855b077d
Improved "Choosing database" documentation page
2024-06-21 11:44:24 +02:00
Jan Böhmer
4aecfaf4e0
Fixed typo in DATABASE_URL env in debian installation guide
...
Fixes issue #592
2024-04-15 23:42:44 +02:00
Jan Böhmer
cb7be460d7
Add 64-bit recommendation to installation docs
2024-03-09 00:13:40 +01:00
Jan Böhmer
5d68922f2e
Fixed some typos and grammar issues in documentation
2024-02-23 13:56:23 +01:00
Jan Böhmer
dcf85f9d5e
Add hint about bad unicode treatment in sqlite to dabase choosing guide
...
Related to issue #465
2024-01-16 22:10:29 +01:00
Jan Böhmer
feca20ef77
Added a hint about quotes and TRUSTED_PROXIES setting in docker-compose example
2023-11-28 13:44:17 +01:00
Jan Böhmer
83d43d931c
Added a SAML_BEHIND_PROXY env, which must be set if Part-DB is behind a reverse proxy when using SAML
...
The php-saml library use its own logic to determine the current path, and we need to set the use_proxy_vars so that it respects the proxy FORWARDED headers.
This should fix issue #436
2023-11-25 01:45:08 +01:00
Jan Böhmer
5f86253b94
Add documentation on how to put Part-DB into a subpath of a reverse proxy
...
This fixes issue #428
2023-11-11 23:03:29 +01:00
Pyromane
1409d19922
Update installation_docker.md ( #425 )
...
For the database additionally "restart: unless-stopped" is specified, so that this is also available after a restart of the host.
2023-10-31 13:32:43 +01:00
Jan Böhmer
f32c0f52b6
Fixed formatting and typos in documentation
2023-10-15 13:21:14 +02:00
Andy
eaee4af715
Update installation_guide-debian.md ( #352 )
...
Fixed a typo: (link to configuration.md)
2023-08-21 17:06:12 +02:00
Jan Böhmer
aaff0835a3
Renmed SAMLP_SP_PRIVATE_KEY to SAML_SP_PRIVATE_KEY
...
Now it matches the documented value and follows the naming schema. The old env name is still valid, to maintain backwards compatibility.
Fixes issue #339
2023-08-01 15:31:40 +02:00
Jan Böhmer
4fc9c19893
Removed useless tabs in code blocks in installation guide
2023-07-10 13:26:07 +02:00
Jan Böhmer
f6fcd730a8
Added how you checkout a stable release in the installation guide
...
Related to discussion #317
2023-07-10 13:20:44 +02:00
Jan Böhmer
54c74bac6e
Show in README that we now require PHP 8.1
2023-06-29 23:35:06 +02:00
suuppl
0550c045c7
add missing '-' to code block ( #254 )
2023-03-20 16:28:29 +01:00
Jan Böhmer
2ae34b856a
Added hint about advanced saml config options to documentation
2023-03-04 17:21:22 +01:00
Jan Böhmer
20caad24ed
Improved documentation
2023-03-04 17:15:17 +01:00
Jan Böhmer
eabdd3b11f
Improved documentation for SAML SSO
2023-03-04 16:56:41 +01:00
Jan Böhmer
8fad743e85
Allow to select the priority of SAML role mapping based on the order in the configuration option
2023-03-04 16:52:17 +01:00
Jan Böhmer
bbe4de996a
Added documentation about the SAML_UPDATE_GROUP_ON_LOGIN env
2023-03-01 15:24:47 +01:00
Jan Böhmer
7030e752fc
Added documentation about permission mapping.
2023-03-01 14:56:05 +01:00
Jan Böhmer
d845f8b7e3
Added documentation about the convert-to-saml-user command
2023-03-01 14:36:46 +01:00
Jan Böhmer
cb9433902c
Added SAML configuration options to docs
2023-02-28 16:34:51 +01:00
Jan Böhmer
472e1ce0a3
Added documentation on how to setup SAML.
2023-02-28 00:28:31 +01:00
Jan Böhmer
421f2682d6
Improved documentation
2023-02-12 23:23:38 +01:00
Jan Böhmer
48ceaff026
Improved documentation
2023-02-09 00:42:20 +01:00
Jan Böhmer
5f6671a5aa
Link to docs.part-db.de
2023-02-09 00:14:36 +01:00
Jan Böhmer
50e8529889
Improved docs for MySQL database
2023-02-09 00:01:47 +01:00
Jan Böhmer
9ab2fd5b40
Moved docker-compose directly into docu and added info how to setup docker with MySQL
2023-02-08 23:22:09 +01:00
Jan Böhmer
3a4aa6785d
Improved documentation
2023-02-08 00:52:45 +01:00
Jan Böhmer
4ed25f6184
Added some documentation on which database type to use.
2023-02-07 16:48:05 +01:00
Jan Böhmer
3c79d967b4
Moved remaining docs from github wiki to pages
2023-02-07 13:05:55 +01:00
