Commit Graph

28 Commits

Author SHA1 Message Date
ZhaiSoul
9e72a825f3
docs: RTSP password is optional 2026-05-01 22:24:27 +08:00
ZhaiSoul
bb5e01ac45
docs: add hailo and memryX mx3 driver tips 2026-05-01 22:19:53 +08:00
ZhaiSoul
43e90d6de4
docs: timezone change to select 2026-05-01 22:13:00 +08:00
ZhaiSoul
b893a4f851
docs: Adjust the position of the RTSP password variable option 2026-05-01 21:59:19 +08:00
GuoQing Liu
1b0816db87
Update docs/src/components/DockerComposeGenerator/config/config.yaml
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-05-01 21:52:41 +08:00
GuoQing Liu
4b81a82a32
Update docs/src/components/DockerComposeGenerator/components/StoragePaths.tsx
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-05-01 21:52:32 +08:00
GuoQing Liu
feda1c791c
Update docs/src/components/DockerComposeGenerator/components/StoragePaths.tsx
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-05-01 21:52:25 +08:00
GuoQing Liu
f75e9c30d0
Update docs/src/components/DockerComposeGenerator/config/config.yaml
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-05-01 21:52:15 +08:00
GuoQing Liu
8c9259a973
Update docs/src/components/DockerComposeGenerator/config/config.yaml
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-05-01 21:52:06 +08:00
GuoQing Liu
1df11f3ddd
Update docs/src/components/DockerComposeGenerator/components/OtherOptions.tsx
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-05-01 21:51:58 +08:00
GuoQing Liu
845a813651
Update docs/src/components/DockerComposeGenerator/config/config.yaml
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-05-01 21:51:44 +08:00
ZhaiSoul
4b421c66a5 docs: improve NVIDIA GPU count input 2026-04-29 14:42:29 +08:00
ZhaiSoul
6cc4db1103 docs: remove 5000 port tips 2026-04-29 14:13:32 +08:00
GuoQing Liu
39f9491971
Remove port 5000 configuration for security reasons
Removed unauthenticated Web UI port 5000 from configuration due to security risks.
2026-04-29 04:23:56 +08:00
GuoQing Liu
25031618c7
Rename heading from 'Generic Hardware Acceleration' to 'Generic Hardware Devices' 2026-04-29 04:11:35 +08:00
GuoQing Liu
9769e59e69
Update docs/src/components/DockerComposeGenerator/config/config.yaml
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-04-29 04:08:40 +08:00
GuoQing Liu
deaf67fd8a
Update docs/src/components/DockerComposeGenerator/config/config.yaml
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-04-29 04:08:19 +08:00
GuoQing Liu
cef4355e28
Update docs/src/components/DockerComposeGenerator/config/config.yaml
Co-authored-by: Josh Hawkins <32435876+hawkeye217@users.noreply.github.com>
2026-04-29 04:07:51 +08:00
ZhaiSoul
d007bd0a6f
docs: add more icon support 2026-04-21 22:23:09 +08:00
ZhaiSoul
2420fdc4ce
docs: add docker compose generator 2026-04-21 20:59:16 +08:00
Josh Hawkins
5a5d23b503
Docs refactor (#22703)
Some checks are pending
CI / AMD64 Build (push) Waiting to run
CI / ARM Build (push) Waiting to run
CI / Jetson Jetpack 6 (push) Waiting to run
CI / AMD64 Extra Build (push) Blocked by required conditions
CI / ARM Extra Build (push) Blocked by required conditions
CI / Synaptics Build (push) Blocked by required conditions
CI / Assemble and push default build (push) Blocked by required conditions
* add generation script

a script to read yaml code blocks from docs markdown files and generate corresponding "Frigate UI" tab instructions based on the json schema, i18n, section configs (hidden fields), and nav mappings

* first pass

* components

* add to gitignore

* second pass

* fix broken anchors

* fixes

* clean up tabs

* version bump

* tweaks

* remove role mapping config from ui
2026-03-30 10:36:45 -06:00
GuoQing Liu
de593c8e3f
docs: add shm calulator (#22103)
Some checks are pending
CI / AMD64 Build (push) Waiting to run
CI / ARM Build (push) Waiting to run
CI / Jetson Jetpack 6 (push) Waiting to run
CI / AMD64 Extra Build (push) Blocked by required conditions
CI / ARM Extra Build (push) Blocked by required conditions
CI / Synaptics Build (push) Blocked by required conditions
CI / Assemble and push default build (push) Blocked by required conditions
* docs: add shm calulator

* feat: update shm calculator tips && style
2026-03-24 07:40:11 -06:00
GuoQing Liu
19480867fb
docs: add highlight magic comments (#22367) 2026-03-10 07:18:02 -06:00
GuoQing Liu
9d4aac2b8e
Revise the README_CN (#21048)
Some checks are pending
CI / AMD64 Build (push) Waiting to run
CI / ARM Build (push) Waiting to run
CI / Jetson Jetpack 6 (push) Waiting to run
CI / AMD64 Extra Build (push) Blocked by required conditions
CI / ARM Extra Build (push) Blocked by required conditions
CI / Synaptics Build (push) Blocked by required conditions
CI / Assemble and push default build (push) Blocked by required conditions
* docs: update chinese readme

* style: Improve the styling of the Chinese document jump tips bar in dark mode

* docs: add license translation
2025-12-01 10:52:30 -07:00
Josh Hawkins
815303922d
Miscellaneous Fixes (#21005)
* update live view docs

* use swr as single source of truth for searchDetail

rather than maintaining a separate state, derive the selected item from swr cache. fixes websocket sync when regenerating descriptions or fetching transcriptions

* fix key warning in console

* don't try to fetch event from review item for audio events

* update audio transcription toast wording

* Add a community supported badge to specific detectors in the info summaries to better separate

* Make object classification publish to tracked object update and add examples for state classification

* Add item to advanced docs about tensorflow limiting

* Don't show submission for in progress objects

* fix for ios not reporting video dimensions on initial metadata load

in testing, polling with requestAnimationFrame finds the dimensions within 2 frames

* Catch jetson nvidia device tree

---------

Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com>
2025-11-23 08:40:25 -07:00
GuoQing Liu
83188e7ea4
Add chinese docs (#17954)
* add docs chinese i18n

* fix some broken links

* update some i18n

* update chinese docs

* add chinese community docs

* Change docs i18n chinese label
2025-05-06 08:49:49 -06:00
Rui Alves
757150dec1
Use Swagger documentation for Frigate HTTP API (#14178)
* Updated documentation

* docusaurus.config and sidebars converted to Typescript to allow for typings

* Added type for sidebars.ts

* Replaced integrations/api.md with automatically generated openAPI specification. Make sidebar collapsible to increase readability

* Fix HTTP API links in the documentation

* Added rust as language in the openapi sidebar

* Make sure configuration/pwa is present

* Fix API slug

* Fix links

* Revert sidebarCollapsible configuration

* Make HTTP API sidebar collapsed by default. Added CSS for OpenAPI methods

* Proper localhost server path

* Proper localhost server path

* No introduction page

* Lint
2024-10-07 14:27:35 -06:00
Paul Armstrong
6790467bbc docs: move docs to docusaurus 2021-01-26 21:40:33 -06:00