diff --git a/README.md b/README.md index da94848..24addac 100644 --- a/README.md +++ b/README.md @@ -16,19 +16,17 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will grab, sort, and rename them. Note that only one type of a given book is supported. If you want both an audiobook and ebook of a given book you will need multiple instances. +Readarr is an eBook and audiobook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available. It does not manage comics or magazines. **Shipped version:** 0.3.6.2232~ynh1 -**Demo:** https://demo.example.com - ## Screenshots ![Screenshot of Readarr](./doc/screenshots/calendar.png) ## Documentation and resources -* Official app website: +* Official app website: * Official admin documentation: * Upstream app code repository: * Report a bug: diff --git a/README_fr.md b/README_fr.md index abb38cc..6215c56 100644 --- a/README_fr.md +++ b/README_fr.md @@ -21,15 +21,13 @@ Readarr est un gestionnaire de collections de livres électroniques et de livres **Version incluse :** 0.3.6.2232~ynh1 -**Démo :** https://demo.example.com - ## Captures d’écran ![Capture d’écran de Readarr](./doc/screenshots/calendar.png) ## Documentations et ressources -* Site officiel de l’app : +* Site officiel de l’app : * Documentation officielle de l’admin : * Dépôt de code officiel de l’app : * Signaler un bug : diff --git a/conf/config.xml b/conf/config.xml new file mode 100644 index 0000000..b450952 --- /dev/null +++ b/conf/config.xml @@ -0,0 +1,17 @@ + + info + 127.0.0.1 + False + + __PORT__ + __PATH__ + __API_KEY__ + None + BuiltIn + develop + __PORT__ + False + + False + Readarr + diff --git a/conf/nginx.conf b/conf/nginx.conf index fe1be8c..495e2c1 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -13,7 +13,7 @@ location __PATH__/ { } # Allow the API External Access via NGINX -location ^~ /readarr/api { +location ^~ __PATH__/api { auth_basic off; proxy_pass http://127.0.0.1:__PORT__; } diff --git a/conf/systemd.service b/conf/systemd.service index c2c4fad..62415b3 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,5 +1,5 @@ [Unit] -Description=Radarr Daemon +Description=Readarr Daemon After=network.target [Service] @@ -7,44 +7,10 @@ Type=simple User=__APP__ Group=__APP__ WorkingDirectory=__INSTALL_DIR__/ -ExecStart=__INSTALL_DIR__/Readarr -nobrowser -data=__DATA_DIR__ +ExecStart=__INSTALL_DIR__/Readarr -nobrowser -data=__DATA_DIR__/ TimeoutStopSec=20 KillMode=process Restart=on-failure -# Sandboxing options to harden security -# Depending on specificities of your service/app, you may need to tweak these -# .. but this should be a good baseline -# Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html -NoNewPrivileges=yes -PrivateTmp=yes -PrivateDevices=yes -RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK -RestrictNamespaces=yes -RestrictRealtime=yes -DevicePolicy=closed -ProtectClock=yes -ProtectHostname=yes -ProtectProc=invisible -ProtectSystem=full -ProtectControlGroups=yes -ProtectKernelModules=yes -ProtectKernelTunables=yes -LockPersonality=yes -SystemCallArchitectures=native -SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged - -# Denying access to capabilities that should not be relevant for webapps -# Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html -CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD -CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE -CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT -CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK -CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM -CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG -CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE -CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW -CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG - [Install] WantedBy=multi-user.target diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index c4dc93b..c567488 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1 +1 @@ -Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will grab, sort, and rename them. Note that only one type of a given book is supported. If you want both an audiobook and ebook of a given book you will need multiple instances. \ No newline at end of file +Readarr is an eBook and audiobook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available. It does not manage comics or magazines. \ No newline at end of file diff --git a/manifest.toml b/manifest.toml index 4d3ccf7..adf7a70 100644 --- a/manifest.toml +++ b/manifest.toml @@ -13,11 +13,10 @@ maintainers = ["eric_G"] [upstream] license = "GPL-3.0" -website = "https://example.com" -demo = "https://demo.example.com" +website = "https://readarr.com/" admindoc = "https://wiki.servarr.com/readarr/installation/linux" code = "https://github.com/Readarr/Readarr" -fund = "https://readarr.com/donate" +fund = "https://opencollective.com/readarr" [integration] yunohost = ">= 11.2" @@ -62,9 +61,9 @@ ram.runtime = "50M" [resources.permissions] main.url = "/" api.url = "/api" - api.show_tile = false api.allowed = "visitors" - api.auth_header = false + api.show_tile = false + api.protected = true [resources.ports] main.default = 8787 diff --git a/scripts/install b/scripts/install index 2cc10d3..afd05bb 100755 --- a/scripts/install +++ b/scripts/install @@ -47,6 +47,16 @@ yunohost service add $app --description="Book Manager and Automation" --log="/va #chmod 400 "$install_dir/some_config_file" #chown $app:$app "$install_dir/some_config_file" +#================================================= +# ADD A CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring $app..." --weight=2 + +api_key=$(ynh_string_random --length=32) +ynh_app_setting_set --app=$app --key=api_key --value=$api_key + +ynh_add_config --template="../conf/config.xml" --destination="$data_dir/config.xml" + #================================================= # GENERIC FINALIZATION #================================================= diff --git a/tests.toml b/tests.toml index 94abb79..c81bf7c 100644 --- a/tests.toml +++ b/tests.toml @@ -3,3 +3,9 @@ test_format = 1.0 [default] + + # ------------ + # Tests to run + # ------------ + + exclude = ["install.multi"] \ No newline at end of file