mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-11 02:11:01 +01:00
GitHub bot : README updated
This commit is contained in:
github-actions
23
README.md
23
README.md
@@ -204,6 +204,7 @@ If you want to do add the repository manually, please follow the procedure highl
|
|||||||
![aarch64][aarch64-badge]
|
![aarch64][aarch64-badge]
|
||||||
![amd64][amd64-badge]
|
![amd64][amd64-badge]
|
||||||
![armv7no][armv7no-badge]
|
![armv7no][armv7no-badge]
|
||||||
|
![ingress][ingress-badge]
|
||||||
![smb][smb-badge]
|
![smb][smb-badge]
|
||||||
![localdisks][localdisks-badge]
|
![localdisks][localdisks-badge]
|
||||||
|
|
||||||
@@ -509,17 +510,6 @@ If you want to do add the repository manually, please follow the procedure highl
|
|||||||
![amd64][amd64-badge]
|
![amd64][amd64-badge]
|
||||||
![armv7no][armv7no-badge]
|
![armv7no][armv7no-badge]
|
||||||
|
|
||||||
✓ [Paperless NGX](paperless_ngx/) : Scan, index and archive all your physical documents
|
|
||||||
|
|
||||||
  
|
|
||||||
|
|
||||||
![aarch64][aarch64-badge]
|
|
||||||
![amd64][amd64-badge]
|
|
||||||
![armv7no][armv7no-badge]
|
|
||||||
![MariaDB][mariadb-badge]
|
|
||||||
![smb][smb-badge]
|
|
||||||
![localdisks][localdisks-badge]
|
|
||||||
|
|
||||||
✓ [Papermerge](papermerge/) : Open source document management system (DMS)
|
✓ [Papermerge](papermerge/) : Open source document management system (DMS)
|
||||||
|
|
||||||
  
|
  
|
||||||
@@ -865,6 +855,17 @@ If you want to do add the repository manually, please follow the procedure highl
|
|||||||
![smb][smb-badge]
|
![smb][smb-badge]
|
||||||
![localdisks][localdisks-badge]
|
![localdisks][localdisks-badge]
|
||||||
|
|
||||||
|
✓ [zzz_archived - Paperless NGX](zzz_archived_paperless_ngx/) : Scan, index and archive all your physical documents
|
||||||
|
|
||||||
|
  
|
||||||
|
|
||||||
|
![aarch64][aarch64-badge]
|
||||||
|
![amd64][amd64-badge]
|
||||||
|
![armv7no][armv7no-badge]
|
||||||
|
![MariaDB][mariadb-badge]
|
||||||
|
![smb][smb-badge]
|
||||||
|
![localdisks][localdisks-badge]
|
||||||
|
|
||||||
✓ [zzz_archived - Vaultwarden](zzz_archived_bitwarden/) : Deprecated - please use community version
|
✓ [zzz_archived - Vaultwarden](zzz_archived_bitwarden/) : Deprecated - please use community version
|
||||||
|
|
||||||
  
|
  
|
||||||
|
|||||||
152
codex/README.md
152
codex/README.md
@@ -1,76 +1,76 @@
|
|||||||
# Home assistant add-on: Codex
|
# Home assistant add-on: Codex
|
||||||
|
|
||||||
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
||||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
||||||
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
||||||
|
|
||||||
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
||||||
|
|
||||||
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
||||||
|
|
||||||
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[Codex](https://github.com/ajslater/codex) is a web based comic archive browser and reader
|
[Codex](https://github.com/ajslater/codex) is a web based comic archive browser and reader
|
||||||
This addon is based on the official docker image : https://hub.docker.com/r/ajslater/codex
|
This addon is based on the official docker image : https://hub.docker.com/r/ajslater/codex
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
||||||
|
|
||||||
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
||||||
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
||||||
1. Install this add-on.
|
1. Install this add-on.
|
||||||
1. Click the `Save` button to store your configuration.
|
1. Click the `Save` button to store your configuration.
|
||||||
1. Set the add-on options to your preferences
|
1. Set the add-on options to your preferences
|
||||||
1. Start the add-on.
|
1. Start the add-on.
|
||||||
1. Check the logs of the add-on to see if everything went well.
|
1. Check the logs of the add-on to see if everything went well.
|
||||||
1. Open the webUI and adapt the software options
|
1. Open the webUI and adapt the software options
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Webui can be found at <http://homeassistant:PORT>.
|
Webui can be found at <http://homeassistant:PORT>.
|
||||||
The default username/password : described in the startup log.
|
The default username/password : described in the startup log.
|
||||||
Configurations can be done through the app webUI, except for the following options
|
Configurations can be done through the app webUI, except for the following options
|
||||||
|
|
||||||
## Add theme/squeleton
|
## Add theme/squeleton
|
||||||
|
|
||||||
You can place the user folder from the theme/skeleton in /share/codex/www/user,
|
You can place the user folder from the theme/skeleton in /share/codex/www/user,
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
PGID: user
|
PGID: user
|
||||||
GPID: user
|
GPID: user
|
||||||
TZ : will explicitly the timezone in long format (e.g. "America/Los Angeles"). This is useful inside Docker because codex cannot automatically detect the host machine's timezone
|
TZ : will explicitly the timezone in long format (e.g. "America/Los Angeles"). This is useful inside Docker because codex cannot automatically detect the host machine's timezone
|
||||||
CODEX_RESET_ADMIN=1 : will reset the admin user and its password to defaults when codex starts.
|
CODEX_RESET_ADMIN=1 : will reset the admin user and its password to defaults when codex starts.
|
||||||
CODEX_SKIP_INTEGRITY_CHECK=1 : will skip the database integrity repair that runs when codex starts
|
CODEX_SKIP_INTEGRITY_CHECK=1 : will skip the database integrity repair that runs when codex starts
|
||||||
csrf_allowed : comma separated list of addresses allowed to access the app
|
csrf_allowed : comma separated list of addresses allowed to access the app
|
||||||
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
|
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. ex. sda1, sdb1, MYNAS...
|
||||||
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
|
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
|
||||||
cifsusername: "username" # optional, smb username, same for all smb shares
|
cifsusername: "username" # optional, smb username, same for all smb shares
|
||||||
cifspassword: "password" # optional, smb password
|
cifspassword: "password" # optional, smb password
|
||||||
```
|
```
|
||||||
|
|
||||||
## Illustration
|
## Illustration
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
Create an issue on github
|
Create an issue on github
|
||||||
|
|
||||||
[repository]: https://github.com/alexbelgium/hassio-addons
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
||||||
|
|||||||
Reference in New Issue
Block a user