A continuation of HomeBox the inventory and organization system built for the Home User
chore: General cleanup tasks (#88)
Matt Kilgore552cb0bf539c
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.mdindex f4e8f047..a0e38919 100644--- a/.github/pull_request_template.md+++ b/.github/pull_request_template.md@@ -55,18 +55,4 @@ _(fill-in or delete this section)_<!--Describe how you tested this change.--->--## Release Notes--_(REQUIRED)_-<!--- If this PR makes user facing changes, please describe them here. This- description will be copied into the release notes/changelog, whenever the- next version is released. Keep this section short, and focus on high level- changes.- Put your text between the block. To omit notes, use NONE within the block.--->--```release-note-```\ No newline at end of file+-->\ No newline at end of filediff --git a/SECURITY.md b/SECURITY.mdindex 56b13b51..58af1f43 100644--- a/SECURITY.md+++ b/SECURITY.md@@ -6,4 +6,6 @@ Since this software is still considered beta/WIP support is always only given fo## Reporting a Vulnerability-Please open a normal public issue if you have any security related concerns.\ No newline at end of file+Please open a normal public issue for minor security issues or general security inquires.++For major or critical security issues, please open a private github security issue.\ No newline at end of filediff --git a/docs/en/quick-start.md b/docs/en/quick-start.mdindex 2d278fed..791edf20 100644--- a/docs/en/quick-start.md+++ b/docs/en/quick-start.md@@ -46,11 +46,14 @@ volumes:homebox-data:driver: local```-::: infoIf you use the `rootless` image, and instead of using named volumes you would prefer using a hostMount directly (e.g., `volumes: [ /path/to/data/folder:/data ]`) you need to `chown` the chosen directory in advance to the `65532` user (as shown in the Docker example above).:::+::: warning+If you have previously set up docker compose with the `HBOX_WEB_READ_TIMEOUT`, `HBOX_WEB_WRITE_TIMEOUT`, or `HBOX_IDLE_TIMEOUT` options, and you were previously using the hay-kot image, please note that you will have to add an `s` for seconds or `m` for minutes to the end of the integers. A dependency update removed the defaultation to seconds and it now requires an explicit duration time.+:::+## Env Variables & Configuration| Variable | Default | Description |@@ -59,15 +62,15 @@ If you use the `rootless` image, and instead of using named volumes you would pr| HBOX_WEB_PORT | 7745 | port to run the web server on, if you're using docker do not change this || HBOX_WEB_HOST | | host to run the web server on, if you're using docker do not change this || HBOX_OPTIONS_ALLOW_REGISTRATION | true | allow users to register themselves |-| HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID | true | auto increments the asset_id field for new items |+| HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID | true | auto-increments the asset_id field for new items || HBOX_OPTIONS_CURRENCY_CONFIG | | json configuration file containing additional currencie || HBOX_WEB_MAX_UPLOAD_SIZE | 10 | maximum file upload size supported in MB |-| HBOX_WEB_READ_TIMEOUT | 10 | Read timeout of HTTP sever |-| HBOX_WEB_WRITE_TIMEOUT | 10 | Write timeout of HTTP server |-| HBOX_WEB_IDLE_TIMEOUT | 30 | Idle timeout of HTTP server |+| HBOX_WEB_READ_TIMEOUT | 10s | Read timeout of HTTP sever |+| HBOX_WEB_WRITE_TIMEOUT | 10s | Write timeout of HTTP server |+| HBOX_WEB_IDLE_TIMEOUT | 30s | Idle timeout of HTTP server || HBOX_STORAGE_DATA | /data/ | path to the data directory, do not change this if you're using docker || HBOX_STORAGE_SQLITE_URL | /data/homebox.db?_fk=1 | sqlite database url, if you're using docker do not change this |-| HBOX_LOG_LEVEL | info | log level to use, can be one of: trace, debug, info, warn, error, critical |+| HBOX_LOG_LEVEL | info | log level to use, can be one of trace, debug, info, warn, error, critical || HBOX_LOG_FORMAT | text | log format to use, can be one of: text, json || HBOX_MAILER_HOST | | email host to use, if not set no email provider will be used || HBOX_MAILER_PORT | 587 | email port to use |diff --git a/fly.toml b/fly.tomldeleted file mode 100644index 22dca66a..00000000--- a/fly.toml+++ /dev/null@@ -1,44 +0,0 @@-# fly.toml file generated for homebox on 2022-09-08T16:00:08-08:00--app = "homebox"-kill_signal = "SIGINT"-kill_timeout = 5-processes = []--[build.args]- COMMIT = "HEAD"- VERSION = "nightly"--[env]- PORT = "7745"- HBOX_DEMO = "true"--[experimental]- allowed_public_ports = []- auto_rollback = true--[[services]]- http_checks = []- internal_port = 7745- processes = ["app"]- protocol = "tcp"- script_checks = []- [services.concurrency]- hard_limit = 25- soft_limit = 20- type = "connections"-- [[services.ports]]- force_https = true- handlers = ["http"]- port = 80-- [[services.ports]]- handlers = ["tls", "http"]- port = 443-- [[services.tcp_checks]]- grace_period = "1s"- interval = "15s"- restart_limit = 0- timeout = "2s"diff --git a/renovate.json b/renovate.jsondeleted file mode 100644index 39a2b6e9..00000000--- a/renovate.json+++ /dev/null@@ -1,6 +0,0 @@-{- "$schema": "https://docs.renovatebot.com/renovate-schema.json",- "extends": [- "config:base"- ]-}