mirrors/homebox
1
0
Fork 0
mirror of https://github.com/sysadminsmedia/homebox.git synced 2026-01-04 20:14:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation for the external label service feature. (#1018)

Browse Source 
* Added documentation for the external label service feature. Re-ordered the columns in the config page to make it easier to read.

* Update docs/en/configure/index.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: Matt <tankerkiller125@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This commit is contained in:
Dan
2025-12-23 21:36:19 +00:00
committed by GitHub
parent 545993a8aa
commit 0f4f398b5a
4 changed files with 59 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/.vitepress/menus/en.mts
View File

@@ -21,7 +21,8 @@ export default [
{
text: 'Advanced',
items: [
{text: 'Import CSV', link: '/en/import-csv'},
{text: 'Import CSV', link: '/en/advanced/import-csv'},
{text: 'External Label Service', link: '/en/advanced/external-label-service'},
]
},
{

53
docs/en/advanced/external-label-service.md Normal file
View File

@@ -0,0 +1,53 @@
# External Label Service
You can use an external web service to generate asset and location labels in homebox. This is useful if you have custom requirements for your labels and are happy to spin up a web service that can accept incoming requests and return an image file for homebox to use.
::: info "Note"
This service is not called to generate sheets of labels accessed via the label generator function. It is used when creating labels from an item or location.
:::
## Configuration
The extenal service is configured using the `HBOX_LABEL_MAKER_LABEL_SERVICE_URL` enviroment variable.
## Request
The service is called using an **HTTP `GET` request**. All parameters are passed as part of the **query string**.
#### Headers
- **User-Agent**: Homebox-LabelMaker/1.0
- **Accept**: image/*
#### Parameters
| Parameter | Type | Description | Value |
| --------------------- | ------ | -------------------------------------------- | --------------------------------------------------------------------- |
| AdditionalInformation | string | Extra free text to include on the label. | `HBOX_LABEL_MAKER_ADDITIONAL_INFORMATION` |
| ComponentPadding | int | Padding around label components (pixels). | `HBOX_LABEL_MAKER_PADDING` |
| DescriptionFontSize | float | Font size for the description text. | |
| DescriptionText | string | Descriptive text, can be multi-line. | Item name or "Homebox Location" |
| Dpi | float | Rendering resolution (dots per inch). | |
| DynamicLength | bool | Whether the label length should auto-adjust. | `HBOX_LABEL_MAKER_DYNAMIC_LENGTH` |
| Height | int | Label height in pixels. | `HBOX_LABEL_MAKER_HEIGHT` |
| Margin | int | Margin around the label in pixels. | `HBOX_LABEL_MAKER_MARGIN` |
| QrSize | int | Size of the QR code element in pixels. | |
| TitleFontSize | float | Font size for the title text. | |
| TitleText | string | Main label title (e.g. product code). | Asset ID or Location Name |
| URL | string | URL to be encoded into the QR code. | Generated based on the configured homebox URL and Asset / Location ID |
| Width | int | Label width in pixels. | `HBOX_LABEL_MAKER_WIDTH` |
## Response
The external service should respond with the following specifications;
- **Size:** Less than or equal to `HBOX_WEB_MAX_UPLOAD_SIZE` (Default: 10Mb)
- **Content-Type**: Specified in the response header should be of the type image/*
- **Time**: Within the time specified in `HBOX_LABEL_MAKER_LABEL_SERVICE_TIMEOUT` (Default 30s)

0
docs/en/import-csv.md → docs/en/advanced/import-csv.md
View File

5
docs/en/configure/index.md
View File

@@ -153,7 +153,7 @@ Options:
### HBOX_WEB_HOST examples
| Value | Notes |
|-----------------------------|------------------------------------------------------------|
| --------------------------- | ---------------------------------------------------------- |
| 0.0.0.0 | Visible all interfaces (default behaviour) |
| 127.0.0.1 | Only visible on same host |
| 100.64.0.1 | Only visible on a specific interface (e.g., VPN in a VPS). |
@@ -187,6 +187,7 @@ the webserver (Caddy) can access it. Other processes/containers on the host
cannot connect to Homebox directly, bypassing the webserver.
File: homebox.socket
```systemd
# /usr/local/lib/systemd/system/homebox.socket
[Unit]
@@ -202,6 +203,7 @@ WantedBy=sockets.target
```
File: homebox.service
```systemd
# /usr/local/lib/systemd/system/homebox.service
[Unit]
@@ -222,6 +224,7 @@ CapabilityBoundingSet=
RestrictNamespaces=true
SystemCallFilter=@system-service
```
Usage:
```bash