Skip to content

Commit 4b1d313

Browse files
Get rid of codenotary references from addon docs
1 parent cb8bec6 commit 4b1d313

File tree

3 files changed

+0
-10
lines changed

3 files changed

+0
-10
lines changed

docs/add-ons/configuration.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,6 @@ Avoid using `config.yaml` as filename in your add-on for anything other than the
173173
| `options` | dict | | Default options value of the add-on.
174174
| `schema` | dict | | Schema for options value of the add-on. It can be `false` to disable schema validation and options.
175175
| `image` | string | | For use with Docker Hub and other container registries. This should be set to the name of the image only (E.g, `ghcr.io/home-assistant/{arch}-addon-example`). If you use this option, set the active docker tag using the `version` option.
176-
| `codenotary` | string | | For use with Codenotary CAS. This is the E-Mail address used to verify your image with Codenotary (E.g, `[email protected]`). This should match the E-Mail address used as the signer in the [add-on's extended build options](#add-on-extended-build)
177176
| `timeout` | integer | 10 | Default 10 (seconds). The timeout to wait until the Docker daemon is done or will be killed.
178177
| `tmpfs` | bool | `false` | If this is set to `true`, the containers `/tmp` uses tmpfs, a memory file system.
179178
| `discovery` | list | | A list of services that this add-on provides for Home Assistant.
@@ -272,9 +271,6 @@ args:
272271
| build_from | no | A dictionary with the hardware architecture as the key and the base Docker image as the value.
273272
| args | no | Allow additional Docker build arguments as a dictionary.
274273
| labels | no | Allow additional Docker labels as a dictionary.
275-
| codenotary | no | Enable container signature with codenotary CAS.
276-
| codenotary.signer | no | Owner signer E-Mail address for this image.
277-
| codenotary.base_image | no | Verify the base container image. If you use our official images, use `[email protected]`
278274

279275
We provide a set of [base images][docker-base] which should cover a lot of needs. If you don't want to use the Alpine based version or need a specific image tag, feel free to pin this requirement for your build with the `build_from` option.
280276

docs/add-ons/presentation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,6 @@ Each add-on starts with a base rating of 5, on a scale of 1 to 6. Depending on d
219219
|---|---|---|
220220
| Use `ingress: true` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | +2 | overrides `auth_api` rating |
221221
| Use `auth_api: true` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | +1 | overridden by `ingress` |
222-
| Add-on is signed with [CodeNotary](https://cas.codenotary.com/)| +1||
223222
| Use custom [`apparmor.txt`](/docs/add-ons/presentation#apparmor)| +1| Rating applied after installation |
224223
| Set `apparmor: false` in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options) | -1 | |
225224
| Use `privileged: NET_ADMIN`, `SYS_ADMIN`, `SYS_RAWIO`, `SYS_PTRACE`, `SYS_MODULE`, or `DAC_READ_SEARCH`, or `kernel_modules: ` used in [`config.yaml`](/docs/add-ons/configuration#optional-configuration-options)| -1 | Rating applied only once if multiple are used. |

docs/add-ons/security.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ For access to the Supervisor API you need to define a role or run in default mod
1818
| `manager` | Is for Add-ons that run CLIs and need extended rights |
1919
| `admin` | Have access to every API call. That is the only one they can disable/enable the Add-on protection mode |
2020

21-
## Codenotary CAS
22-
23-
You can sign your images and also verify our base image which you build from to provide a full chain of trust. This feature is supported by our [Builder](https://github.com/home-assistant/builder) and the [build config](/docs/add-ons/configuration#add-on-extended-build). To enable this feature on the Supervisor for your add-on, you simply need to add your email address to the add-on configuration `codenotary`.
24-
2521
## Protection
2622

2723
Default, all add-ons run in protection enabled mode. This mode prevents the add-on from getting any rights on the system. If an add-on requires more rights, you can disable this protection via the API add-on options for that add-on. But be careful, an add-on with disabled protection can destroy your system!
@@ -34,7 +30,6 @@ As a developer, follow the following best practices to make your add-on secure:
3430
- Create an AppArmor profile
3531
- Map folders read only if you don't need write access
3632
- If you need any API access, make sure that you do not grant permission that aren't needed
37-
- Sign the image with [Codenotary CAS](https://cas.codenotary.com/)
3833

3934
## Use Home Assistant user backend
4035

0 commit comments

Comments
 (0)