organize deployment configs and documentation
This commit is contained in:
@@ -0,0 +1,20 @@
|
||||
# Embedded frontend
|
||||
|
||||
The frontend under `static/` is embedded into the executable at compile time.
|
||||
No separate web root or static-file bind mount is required.
|
||||
|
||||
It includes URL creation and lookup, short-link metadata, copy and delete
|
||||
actions, API-key administration, sorting, pagination, theme selection, and
|
||||
locally hosted fonts. Relative asset URLs and the browser-derived API prefix
|
||||
allow the same files to work at either a subdomain root or a nested path.
|
||||
|
||||
Set `production = false` for the normal self-contained deployment. Setting it
|
||||
to `true` disables the embedded frontend routes for installations that serve
|
||||
those files separately.
|
||||
|
||||
The nginx examples apply `no-store` to the HTML entry point and `no-cache` to
|
||||
static assets. Embedded static requests do not consume the API rate-limit
|
||||
quota.
|
||||
|
||||
Automated tests compare every embedded asset with its source file byte for
|
||||
byte. See [Development, testing, and releases](development.md).
|
||||
Reference in New Issue
Block a user