Skip to content

Commit 7522d92

Browse files
committed
use docs instead of gh-pages
1 parent 0adeb81 commit 7522d92

File tree

163 files changed

+5520
-13
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+5520
-13
lines changed

.github/copilot-instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ The plugin supports automation via:
203203
- **Switches**: HomeKit switches for manual triggering
204204

205205
### Tested Configuration Management
206-
The repository maintains a collection of tested camera configurations submitted by users via GitHub issues labeled "tested config". These configurations are displayed on the project documentation website at https://sunoo.github.io/homebridge-camera-ffmpeg/configs/.
206+
The repository maintains a collection of tested camera configurations submitted by users via GitHub issues labeled "tested config". These configurations are displayed on the project documentation website at https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/configs/.
207207

208208
#### Processing Tested Config Issues
209209
When working with issues that have the "tested config" label:
@@ -239,7 +239,7 @@ When working with issues that have the "tested config" label:
239239
- **Updates**: Update documentation links when adding new tested configurations
240240

241241
#### Integration with Documentation Website
242-
The project uses a documentation website (sunoo.github.io/homebridge-camera-ffmpeg/) that includes:
242+
The project uses a documentation website (homebridge-plugins.github.io/homebridge-camera-ffmpeg/) that includes:
243243
- `/configs/` - Tested configuration repository
244244
- `/automation/mqtt.html` - MQTT automation documentation
245245
- `/automation/http.html` - HTTP automation documentation

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ All notable changes to this project will be documented in this file. This projec
7777

7878
### What's Changes
7979
#### Breaking Changes
80-
- Complete rework of MQTT support. Now topics and messages are configurable per camera, which should allow any camera with MQTT support to work directly with this plugin. If you need compatibility with the way prior versions worked, you can follow [this config example](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/mqtt.html#legacy-compatibility).
80+
- Complete rework of MQTT support. Now topics and messages are configurable per camera, which should allow any camera with MQTT support to work directly with this plugin. If you need compatibility with the way prior versions worked, you can follow [this config example](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/mqtt.html#legacy-compatibility).
8181
- Dropped support for older versions of Homebridge, now requires version 1.1.3 or newer.
8282

8383
#### Other Changes

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Homebridge Camera FFmpeg
22

3-
[![npm](https://badgen.net/npm/v/homebridge-camera-ffmpeg) ![npm](https://badgen.net/npm/dt/homebridge-camera-ffmpeg)](https://www.npmjs.com/package/homebridge-camera-ffmpeg) [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) [![certified-hoobs-plugin](https://badgen.net/badge/HOOBS/certified/yellow)](https://plugins.hoobs.org/plugin/homebridge-camera-ffmpeg)
3+
[![npm](https://badgen.net/npm/v/@homebridge-plugins/homebridge-camera-ffmpeg) ![npm](https://badgen.net/npm/dt/@homebridge-plugins/homebridge-camera-ffmpeg)](https://www.npmjs.com/package/@homebridge-plugins/homebridge-camera-ffmpeg) [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) [![certified-hoobs-plugin](https://badgen.net/badge/HOOBS/certified/yellow)](https://plugins.hoobs.org/plugin/homebridge-camera-ffmpeg)
44

55
[Homebridge](https://homebridge.io) Plugin Providing [FFmpeg](https://www.ffmpeg.org)-based Camera Support
66

@@ -15,7 +15,7 @@ This plugin is supported under both [Homebridge](https://homebridge.io) and [HOO
1515

1616
## Tested configurations
1717

18-
Other users have been sharing configurations that work for them on our GitHub site. You may want to [check that](https://sunoo.github.io/homebridge-camera-ffmpeg/configs/) to see if anyone else has gotten your model of camera working already, or [share](https://github.com/homebridge-plugins/homebridge-camera-ffmpeg/issues/new?assignees=&labels=tested+config&template=tested_config.md) a configuration setup that works for you.
18+
Other users have been sharing configurations that work for them on our GitHub site. You may want to [check that](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/configs/) to see if anyone else has gotten your model of camera working already, or [share](https://github.com/homebridge-plugins/homebridge-camera-ffmpeg/issues/new?assignees=&labels=tested+config&template=tested_config.md) a configuration setup that works for you.
1919

2020
## Manual Configuration
2121

@@ -49,9 +49,9 @@ Other users have been sharing configurations that work for them on our GitHub si
4949

5050
### Optional Parameters
5151

52-
- `motion`: Exposes the motion sensor for this camera. This can be triggered with [dummy switches](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/switch.html), [MQTT messages](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/mqtt.html), or [via HTTP](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/http.html), depending on what features are enabled in the config. (Default: `false`)
53-
- `doorbell`: Exposes the doorbell device for this camera. This can be triggered with [dummy switches](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/switch.html), [MQTT messages](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/mqtt.html), or [via HTTP](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/http.html), depending on what features are enabled in the config. (Default: `false`)
54-
- `switches`: Enables dummy switches to trigger motion and/or doorbell, if either of those are enabled. When enabled there will be an additional switch that triggers the motion or doorbell event. See the project site for [more detailed instructions](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/switch.html). (Default: `false`)
52+
- `motion`: Exposes the motion sensor for this camera. This can be triggered with [dummy switches](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/switch.html), [MQTT messages](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/mqtt.html), or [via HTTP](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/http.html), depending on what features are enabled in the config. (Default: `false`)
53+
- `doorbell`: Exposes the doorbell device for this camera. This can be triggered with [dummy switches](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/switch.html), [MQTT messages](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/mqtt.html), or [via HTTP](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/http.html), depending on what features are enabled in the config. (Default: `false`)
54+
- `switches`: Enables dummy switches to trigger motion and/or doorbell, if either of those are enabled. When enabled there will be an additional switch that triggers the motion or doorbell event. See the project site for [more detailed instructions](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/switch.html). (Default: `false`)
5555
- `motionTimeout`: The number of seconds after triggering to reset the motion sensor. Set to 0 to disable resetting of motion trigger for MQTT or HTTP. (Default: `1`)
5656
- `motionDoorbell`: Rings the doorbell when motion is activated. This allows for motion alerts to appear on Apple TVs. (Default: `false`)
5757
- `manufacturer`: Set the manufacturer name for display in the Home app. (Default: `Homebridge`)
@@ -167,12 +167,12 @@ Other users have been sharing configurations that work for them on our GitHub si
167167

168168
### Automation Parameters
169169

170-
- `mqtt`: Defines the hostname or IP of the MQTT broker to connect to for MQTT-based automation. If not set, MQTT support is not started. See the project site for [more information on using MQTT](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/mqtt.html).
170+
- `mqtt`: Defines the hostname or IP of the MQTT broker to connect to for MQTT-based automation. If not set, MQTT support is not started. See the project site for [more information on using MQTT](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/mqtt.html).
171171
- `portmqtt`: The port of the MQTT broker. (Default: `1883`)
172172
- `tlsmqtt`: Use TLS to connect to the MQTT broker. (Default: `false`)
173173
- `usermqtt`: The username used to connect to your MQTT broker. If not set, no authentication is used.
174174
- `passmqtt`: The password used to connect to your MQTT broker. If not set, no authentication is used.
175-
- `porthttp`: The port to listen on for HTTP-based automation. If not set, HTTP support is not started. See the project site for [more information on using HTTP](https://sunoo.github.io/homebridge-camera-ffmpeg/automation/http.html).
175+
- `porthttp`: The port to listen on for HTTP-based automation. If not set, HTTP support is not started. See the project site for [more information on using HTTP](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/http.html).
176176
- `localhttp`: Only allow HTTP calls from localhost. Useful if using helper plugins that translate to HTTP. (Default: `false`)
177177

178178
#### Automation Example

config.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"customUi": true,
66
"customUiPath": "./dist/homebridge-ui",
77
"headerDisplay": "Homebridge Plugin Providing FFmpeg-based Camera Support.",
8-
"footerDisplay": "You can see configurations that have been shared by other users on [the project site](https://sunoo.github.io/homebridge-camera-ffmpeg/configs/).",
8+
"footerDisplay": "You can see configurations that have been shared by other users on [the project site](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/configs/).",
99
"schema": {
1010
"name": {
1111
"title": "Name",

docs/404.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: default
3+
---
4+
5+
<style type="text/css" media="screen">
6+
.container {
7+
margin: 10px auto;
8+
max-width: 600px;
9+
text-align: center;
10+
}
11+
h1 {
12+
margin: 30px 0;
13+
font-size: 4em;
14+
line-height: 1;
15+
letter-spacing: -1px;
16+
}
17+
</style>
18+
19+
<div class="container">
20+
<h1>404</h1>
21+
22+
<p><strong>Page not found :(</strong></p>
23+
<p>The requested page could not be found.</p>
24+
</div>

docs/Gemfile

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
source "https://rubygems.org"
2+
3+
# Hello! This is where you manage which Jekyll version is used to run.
4+
# When you want to use a different version, change it below, save the
5+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
6+
#
7+
# bundle exec jekyll serve
8+
#
9+
# This will help ensure the proper Jekyll version is running.
10+
# Happy Jekylling!
11+
# gem "jekyll", "~> 3.8.7"
12+
13+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
14+
gem "minima", "~> 2.0"
15+
16+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
17+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
18+
gem "github-pages", group: :jekyll_plugins
19+
20+
# If you have any plugins, put them here!
21+
# group :jekyll_plugins do
22+
# gem "jekyll-feed", "~> 0.6"
23+
# end
24+
25+
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
26+
# and associated library.
27+
install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
28+
gem "tzinfo", "~> 1.2"
29+
gem "tzinfo-data"
30+
end
31+
32+
# Performance-booster for watching directories on Windows
33+
gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
34+

0 commit comments

Comments
 (0)