mirror of
https://github.com/Part-DB/Part-DB-server.git
synced 2026-05-21 02:41:35 +00:00
Merge branch 'master' into feature/kicad-enhancements
This commit is contained in:
commit
6ab75488b4
56 changed files with 7142 additions and 2997 deletions
|
|
@ -86,6 +86,9 @@ bundled with Part-DB. Set `DATABASE_MYSQL_SSL_VERIFY_CERT` if you want to accept
|
|||
* `ATTACHMENT_DOWNLOAD_BY_DEFAULT`: When this is set to 1, the "download external file" checkbox is checked by default
|
||||
when adding a new attachment. Otherwise, it is unchecked by default. Use this if you wanna download all attachments
|
||||
locally by default. Attachment download is only possible, when `ALLOW_ATTACHMENT_DOWNLOADS` is set to 1.
|
||||
* `ATTACHMENT_SHOW_HTML_FILES`: When enabled, user uploaded HTML attachments can be viewed directly in the browser.
|
||||
Many potential malicious functions are restricted, still this is a potential security risk and should only be enabled,
|
||||
if you trust the users who can upload files. When set to 0, HTML files are rendered as plain text.
|
||||
* `USE_GRAVATAR`: Set to `1` to use [gravatar.com](https://gravatar.com/) images for user avatars (as long as they have
|
||||
not set their own picture). The users browsers have to download the pictures from a third-party (gravatar) server, so
|
||||
this might be a privacy risk.
|
||||
|
|
@ -126,6 +129,8 @@ bundled with Part-DB. Set `DATABASE_MYSQL_SSL_VERIFY_CERT` if you want to accept
|
|||
unique increments for parts within a category hierarchy, ensuring consistency and uniqueness in IPN generation.
|
||||
* `IPN_USE_DUPLICATE_DESCRIPTION`: When enabled, the part’s description is used to find existing parts with the same
|
||||
description and to determine the next available IPN by incrementing their numeric suffix for the suggestion list.
|
||||
* `KEYBINDINGS_SPECIAL_CHARS_ENABLED`: Set this to 0 to disable the special character keybindings (Alt + key) for inserting special characters. This can be useful if
|
||||
they conflict with your keyboard layout or system shortcuts.
|
||||
|
||||
### E-Mail settings (all env only)
|
||||
|
||||
|
|
|
|||
|
|
@ -303,7 +303,17 @@ That method is not officially supported nor encouraged by Part-DB, and might bre
|
|||
The following env configuration options are available:
|
||||
* `PROVIDER_CONRAD_API_KEY`: The API key you got from Conrad (mandatory)
|
||||
|
||||
### Custom provider
|
||||
### Canopy / Amazon
|
||||
The Canopy provider uses the [Canopy API](https://www.canopyapi.co/) to search for parts and get shopping information from Amazon.
|
||||
Canopy is a third-party service that provides access to Amazon product data through their API. Their trial plan offers 100 requests per month for free,
|
||||
and they also offer paid plans with higher limits. To use the Canopy provider, you need to create an account on the Canopy website and obtain an API key.
|
||||
Once you have the API key, you can configure the Canopy provider in Part-DB using the web UI or environment variables:
|
||||
|
||||
* `PROVIDER_CANOPY_API_KEY`: The API key you got from Canopy (mandatory)
|
||||
|
||||
|
||||
|
||||
### Custom providers
|
||||
|
||||
To create a custom provider, you have to create a new class implementing the `InfoProviderInterface` interface. As long
|
||||
as it is a valid Symfony service, it will be automatically loaded and can be used.
|
||||
|
|
|
|||
|
|
@ -8,6 +8,21 @@ parent: Usage
|
|||
|
||||
This page lists all the keybindings of Part-DB. Currently, there are only the special character keybindings.
|
||||
|
||||
## Disabling keybindings
|
||||
|
||||
If you want to disable the special character keybindings (for example, because they conflict with your keyboard layout or system shortcuts), you can do so in two ways:
|
||||
|
||||
### Via the System Settings UI (recommended)
|
||||
|
||||
1. Navigate to **System Settings** (Tools → System Settings)
|
||||
2. Go to **Behavior** → **Keybindings**
|
||||
3. Uncheck **Enable special character keybindings**
|
||||
4. Save the settings
|
||||
|
||||
### Via Environment Variable
|
||||
|
||||
Alternatively, you can set the environment variable `KEYBINDINGS_SPECIAL_CHARS_ENABLED=0` in your `.env.local` file or your server environment configuration.
|
||||
|
||||
## Special characters
|
||||
|
||||
Using the keybindings below (Alt + key) you can insert special characters into the text fields of Part-DB. This works on
|
||||
|
|
|
|||
51
docs/usage/scanner.md
Normal file
51
docs/usage/scanner.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
title: Barcode Scanner
|
||||
layout: default
|
||||
parent: Usage
|
||||
---
|
||||
|
||||
# Barcode scanner
|
||||
|
||||
When the user has the correct permission there will be a barcode scanner button in the navbar.
|
||||
On this page you can either input a barcode code by hand, use an external barcode scanner, or use your devices camera to
|
||||
scan a barcode.
|
||||
|
||||
In info mode (when the "Info" toggle is enabled) you can scan a barcode and Part-DB will parse it and show information
|
||||
about it.
|
||||
|
||||
Without info mode, the barcode will directly redirect you to the corresponding page.
|
||||
|
||||
### Barcode matching
|
||||
|
||||
When you scan a barcode, Part-DB will try to match it to an existing part, part lot or storage location first.
|
||||
For Part-DB generated barcodes, it will use the internal ID of a part. Alternatively you can also scan a barcode that contains the part's IPN.
|
||||
|
||||
You can set a GTIN/EAN code in the part properties and Part-DB will open the part page when you scan the corresponding GTIN/EAN barcode.
|
||||
|
||||
On a part lot you can under "Advanced" set a user barcode, that will redirect you to the part lot page when scanned. This allows to reuse
|
||||
arbitrary existing barcodes that already exist on the part lots (for example, from the manufacturer) and link them to the part lot in Part-DB.
|
||||
|
||||
Part-DB can also parse various distributor barcodes (for example from Digikey and Mouser) and will try to redirect you to the corresponding
|
||||
part page based on the distributor part number in the barcode.
|
||||
|
||||
### Part creation from barcodes
|
||||
For certain barcodes Part-DB can automatically create a new part, when it cannot find a matching part.
|
||||
Part-DB will try to retrieve the part information from an information provider and redirects you to the part creation page
|
||||
with the retrieved information pre-filled.
|
||||
|
||||
## Using an external barcode scanner
|
||||
|
||||
Part-DB supports the use of external barcode scanners that emulate keyboard input. To use a barcode scanner with Part-DB,
|
||||
simply connect the scanner to your computer and scan a barcode while the cursor is in a text field in Part-DB.
|
||||
The scanned barcode will be entered into the text field as if you had typed it on the keyboard.
|
||||
|
||||
In scanner fields, it will also try to insert special non-printable characters the scanner send via Alt + key combinations.
|
||||
This is required for EIGP114 datamatrix codes.
|
||||
|
||||
### Automatically redirect on barcode scanning
|
||||
|
||||
If you configure your barcode scanner to send a <SOH> (Start of heading, 0x01) non-printable character at the beginning
|
||||
of the scanned barcode, Part-DB will automatically scan the barcode that comes afterward (and is ended with an enter key)
|
||||
and redirects you to the corresponding page.
|
||||
This allows you to quickly scan a barcode from anywhere in Part-DB without the need to first open the scanner page.
|
||||
If an input field is focused, the barcode will be entered into the field as usual and no redirection will happen.
|
||||
Loading…
Add table
Add a link
Reference in a new issue