├── .gitignore ├── conf ├── cron ├── systemd.service ├── metrics.service ├── local.json ├── docservice.service ├── converter.service └── nginx.conf ├── .gitattributes ├── doc ├── screenshots │ ├── 01-presentation.jpg │ └── 02-document-short.png ├── DESCRIPTION.md ├── DESCRIPTION_fr.md ├── POST_INSTALL.md ├── POST_INSTALL_fr.md ├── ADMIN.md └── ADMIN_fr.md ├── .editorconfig ├── .github ├── PULL_REQUEST_TEMPLATE.md └── ISSUE_TEMPLATE.md ├── tests.toml ├── scripts ├── change_url ├── config ├── remove ├── backup ├── install ├── restore ├── upgrade └── _common.sh ├── README.md ├── config_panel.toml ├── patches └── src │ └── 00-no_limits.patch ├── manifest.toml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *.sw[op] 3 | .DS_Store 4 | -------------------------------------------------------------------------------- /conf/cron: -------------------------------------------------------------------------------- 1 | 45 3 * * * root /usr/bin/systemctl try-restart __APP__ 2 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | tests.toml.example linguist-language=toml 2 | config_panel.toml.example linguist-language=toml 3 | -------------------------------------------------------------------------------- /doc/screenshots/01-presentation.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/onlyoffice_ynh/HEAD/doc/screenshots/01-presentation.jpg -------------------------------------------------------------------------------- /doc/screenshots/02-document-short.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/onlyoffice_ynh/HEAD/doc/screenshots/02-document-short.png -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig: https://editorconfig.org 2 | 3 | # top-most EditorConfig file 4 | root = true 5 | 6 | [*] 7 | charset = utf-8 8 | end_of_line = lf 9 | indent_size = 4 10 | indent_style = space 11 | insert_final_newline = true 12 | spelling_language = en-US 13 | # Let's also remove trailing whitespaces, even in markdown: 14 | # https://www.markdownguide.org/basic-syntax/#line-breaks 15 | trim_trailing_whitespace = true 16 | 17 | [**_fr.md] 18 | spelling_language = fr 19 | -------------------------------------------------------------------------------- /doc/DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | ONLYOFFICE Document Server is an online office suite comprising viewers and editors for texts, spreadsheets and presentations, fully compatible with Office Open XML formats: .docx, .xlsx, .pptx and enabling collaborative editing in real time. 2 | 3 | It could be connected with a lot of apps available in YunoHost like Nextcloud, Seafile, Yeswiki, Mattermost, Moodle and many others. 4 | 5 | OnlyOffice Desktop and mobile apps exists too and can be used to edit your document on a local machine with equivalent features and rendering. 6 | 7 | 8 | -------------------------------------------------------------------------------- /doc/DESCRIPTION_fr.md: -------------------------------------------------------------------------------- 1 | ONLYOFFICE Document Server est une suite bureautique en ligne comprenant des visualiseurs et des éditeurs de textes, feuilles de calcul et présentations, entièrement compatible avec les formats Office Open XML: .docx, .xlsx, .pptx et permettant l'édition collaborative en temps réel. 2 | 3 | OnlyOffice peut être connecté avec de nombreuses apps disponibles dans YunoHost comme Nextcloud, Seafile, Yeswiki, Mattermost, Moodle et beaucoup d'autres. 4 | 5 | Des apps OnlyOffice Desktop et mobile existent aussi et peuvent être utilisées pour éditer des documents sur des équipements en local avec des fonctionnalités et un rendu identique. 6 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Problem 2 | 3 | - *Description of why you made this PR* 4 | 5 | ## Solution 6 | 7 | - *And how do you fix that problem* 8 | 9 | ## PR Status 10 | 11 | - [ ] Code finished and ready to be reviewed/tested 12 | - [ ] The fix/enhancement were manually tested (if applicable) 13 | 14 | ## Automatic tests 15 | 16 | Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) 17 | -------------------------------------------------------------------------------- /doc/POST_INSTALL.md: -------------------------------------------------------------------------------- 1 | __APP__ was successfully installed :) 2 | 3 | To integrate the office editor into your app (Nextcloud, Seafile, etc.): 4 | 1. Install the connector extension dedicated to your application 5 | 2. Configure the following settings in the extension configuration and save (or restart the service if it is a config file): 6 | - Document Server address: “https://__DOMAIN____PATH__” 7 | - JWT secret key: “__JWT_SECRET__” 8 | 3. Test editing or creating a document. 9 | 10 | More information is available in the documentation for this package `Web administration > App > OnlyOffice`. 11 | 12 | If you are facing any problem or want to improve this app, please open a new issue here: 13 | 14 | -------------------------------------------------------------------------------- /tests.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json 2 | 3 | test_format = 1.0 4 | 5 | [default] 6 | 7 | # ------------ 8 | # Tests to run 9 | # ------------ 10 | 11 | # ------------------------------- 12 | # Default args to use for install 13 | # ------------------------------- 14 | 15 | args.allowed_urls = "https://nextcloud.tld" 16 | 17 | # ------------------------------- 18 | # Commits to test upgrade from 19 | # ------------------------------- 20 | 21 | #[default.test_upgrade_from.6fad960ef104f0d96ebd38c3577330efd2c4ed57] 22 | #name = "8.0.1~ynh1" 23 | #args.domain = "domain.tld" 24 | #args.path = "/" 25 | #args.nextclouddomain = "nextcloud.tld" 26 | #args.admin = "package_checker" 27 | -------------------------------------------------------------------------------- /doc/POST_INSTALL_fr.md: -------------------------------------------------------------------------------- 1 | __APP__ a été correctement installé :) 2 | 3 | Pour intégrer l'éditeur bureautique dans votre app (Nextcloud, Seafile, etc.): 4 | 1. Installer l'extension connecteur dédié à votre application 5 | 2. Configurer les paramètres suivants dans la configuration de l'extension et sauvegarder (ou redémarrer le service si c'est un fichier de config): 6 | - Addresse du Document Server: "https://__DOMAIN____PATH__" 7 | - Clé secrète JWT: "__JWT_SECRET__" 8 | 3. Tester l'édition ou la création d'un document. 9 | 10 | Plus d'info sont disponibles dans la documentation de ce paquet `Web administration > App > OnlyOffice`. 11 | 12 | Si vous rencontrez un problème ou souhaitez améliorer cette application, veuillez ouvrir un nouveau ticket ici: 13 | 14 | -------------------------------------------------------------------------------- /scripts/change_url: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | source _common.sh 8 | source /usr/share/yunohost/helpers 9 | 10 | #================================================= 11 | # MODIFY URL IN NGINX CONF 12 | #================================================= 13 | ynh_script_progression "Updating NGINX web server configuration..." 14 | 15 | ynh_config_change_url_nginx 16 | 17 | #================================================= 18 | # SPECIFIC MODIFICATIONS 19 | #================================================= 20 | 21 | conf_dir="$install_dir/config" 22 | 23 | unlink "$conf_dir/nginx/ds.conf" 24 | unlink "$conf_dir/nginx/includes/ds-docservice.conf" 25 | ln -s /etc/nginx/conf.d/$new_domain.d/$app.conf "$conf_dir/nginx/ds.conf" 26 | ln -s /etc/nginx/conf.d/$new_domain.d/$app.conf "$conf_dir/nginx/includes/ds-docservice.conf" 27 | ynh_replace --match="$old_domain" --replace="$new_domain" --file="$install_dir/bin/documentserver-flush-cache.sh" 28 | 29 | #================================================= 30 | # END OF SCRIPT 31 | #================================================= 32 | 33 | ynh_script_progression "Change of URL completed for $app" 34 | -------------------------------------------------------------------------------- /scripts/config: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | source /usr/share/yunohost/helpers 8 | 9 | #================================================= 10 | # RETRIEVE ARGUMENTS 11 | #================================================= 12 | 13 | install_dir=$(ynh_app_setting_get --key=install_dir) 14 | 15 | #================================================= 16 | # SPECIFIC SETTERS FOR TOML SHORT KEYS 17 | #================================================= 18 | set__allowed_urls() { 19 | ynh_replace --match='frame-ancestors [^"]*' --replace="frame-ancestors 'self' $allowed_urls" --file="/etc/nginx/conf.d/$domain.d/$app.conf" 20 | ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" 21 | ynh_app_setting_set --key=allowed_urls --value="$allowed_urls" 22 | ynh_print_info "The nginx config has been edited" 23 | } 24 | 25 | # FIXME: this is a yolo fix to remove after merging https://github.com/YunoHost/yunohost/pull/2186 26 | ynh_app_config_apply() { 27 | _ynh_app_config_apply 28 | ynh_replace --match='"[Ff]alse"' --replace="false" --file="$install_dir/config/local.json" 29 | ynh_replace --match='"[Tt]rue"' --replace="true" --file="$install_dir/config/local.json" 30 | ynh_store_file_checksum "$install_dir/config/local.json" 31 | } 32 | #================================================= 33 | ynh_app_config_run "$1" 34 | -------------------------------------------------------------------------------- /conf/systemd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=__APP__ 3 | 4 | [Service] 5 | Type=oneshot 6 | User=__APP__ 7 | Group=__APP__ 8 | ExecStart=/bin/true 9 | RemainAfterExit=yes 10 | 11 | # Sandboxing options to harden security 12 | # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html 13 | NoNewPrivileges=yes 14 | PrivateTmp=yes 15 | PrivateDevices=yes 16 | RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK 17 | RestrictNamespaces=yes 18 | RestrictRealtime=yes 19 | DevicePolicy=closed 20 | ProtectClock=yes 21 | ProtectHostname=yes 22 | ProtectProc=invisible 23 | ProtectSystem=full 24 | ProtectControlGroups=yes 25 | ProtectKernelModules=yes 26 | ProtectKernelTunables=yes 27 | LockPersonality=yes 28 | SystemCallArchitectures=native 29 | SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged 30 | 31 | # Denying access to capabilities that should not be relevant for webapps 32 | # Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html 33 | CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD 34 | CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE 35 | CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT 36 | CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK 37 | CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM 38 | CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG 39 | CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE 40 | CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW 41 | CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 42 | 43 | [Install] 44 | WantedBy=multi-user.target 45 | 46 | 47 | -------------------------------------------------------------------------------- /scripts/remove: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | source _common.sh 8 | source /usr/share/yunohost/helpers 9 | 10 | #================================================= 11 | # REMOVE SYSTEM CONFIGURATIONS 12 | #================================================= 13 | ynh_script_progression "Removing system configurations related to $app..." 14 | 15 | ynh_config_remove_logrotate 16 | 17 | for service in "$app-converter" "$app-docservice" "$app-metrics" "$app"; do 18 | if ynh_hide_warnings yunohost service status "$service" >/dev/null 19 | then 20 | yunohost service remove "$service" 21 | fi 22 | ynh_config_remove_systemd "$service" 23 | done 24 | 25 | ynh_config_remove_nginx 26 | 27 | ynh_safe_rm "/etc/cron.d/$app" 28 | 29 | #================================================= 30 | # REMOVE RABBIT MQ VHOST 31 | #================================================= 32 | ynh_script_progression "Removing rabbitmq vhost $app..." 33 | 34 | ynh_rabbitmq_remove_vhost 35 | 36 | #================================================= 37 | # REMOVE REDIS DB 38 | #================================================= 39 | ynh_script_progression "Removing redis db..." 40 | 41 | ynh_redis_remove_db $redis_db 42 | 43 | #================================================= 44 | # REMOVE VARIOUS FILES 45 | #================================================= 46 | 47 | # Remove a directory securely 48 | ynh_safe_rm "$install_dir" 49 | 50 | ynh_nodejs_remove 51 | 52 | #================================================= 53 | # END OF SCRIPT 54 | #================================================= 55 | 56 | ynh_script_progression "Removal of $app completed" 57 | -------------------------------------------------------------------------------- /conf/metrics.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Docs Metrics 3 | PartOf=__APP__.service 4 | After=network.target syslog.target __APP__.service 5 | 6 | [Service] 7 | Type=simple 8 | User=__APP__ 9 | Group=__APP__ 10 | WorkingDirectory=__INSTALL_DIR__/documentserver/server/Metrics 11 | ExecStart=/bin/sh -c 'exec __INSTALL_DIR__/documentserver/server/Metrics/metrics ./config/config.js' 12 | StandardOutput=append:/var/log/__APP__/metrics.log 13 | StandardError=inherit 14 | Environment=NODE_DISABLE_COLORS=1 15 | 16 | Restart=always 17 | RestartSec=30 18 | 19 | # Give up if ping don't get an answer 20 | TimeoutSec=600 21 | 22 | # Sandboxing options to harden security 23 | # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html 24 | NoNewPrivileges=yes 25 | PrivateTmp=yes 26 | PrivateDevices=yes 27 | RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK 28 | RestrictNamespaces=yes 29 | RestrictRealtime=yes 30 | DevicePolicy=closed 31 | ProtectClock=yes 32 | ProtectHostname=yes 33 | ProtectProc=invisible 34 | ProtectSystem=full 35 | ProtectControlGroups=yes 36 | ProtectKernelModules=yes 37 | ProtectKernelTunables=yes 38 | LockPersonality=yes 39 | SystemCallArchitectures=native 40 | SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged 41 | 42 | # Denying access to capabilities that should not be relevant for webapps 43 | # Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html 44 | CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD 45 | CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE 46 | CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT 47 | CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK 48 | CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM 49 | CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG 50 | CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE 51 | CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW 52 | CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 53 | 54 | [Install] 55 | WantedBy=__APP__.service 56 | 57 | 58 | -------------------------------------------------------------------------------- /scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 8 | source ../settings/scripts/_common.sh 9 | source /usr/share/yunohost/helpers 10 | 11 | #================================================= 12 | # DECLARE DATA AND CONF FILES TO BACKUP 13 | #================================================= 14 | ynh_print_info "Declaring files to be backed up..." 15 | 16 | #================================================= 17 | # BACKUP THE APP MAIN DIR 18 | #================================================= 19 | 20 | ynh_backup "$install_dir" 21 | 22 | #================================================= 23 | # BACKUP THE DATA DIR 24 | #================================================= 25 | 26 | ynh_backup "$data_dir" 27 | 28 | #================================================= 29 | # SYSTEM CONFIGURATION 30 | #================================================= 31 | 32 | ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" 33 | 34 | ynh_backup "/etc/systemd/system/$app-docservice.service" 35 | ynh_backup "/etc/systemd/system/$app-converter.service" 36 | ynh_backup "/etc/systemd/system/$app-metrics.service" 37 | ynh_backup "/etc/systemd/system/$app.service" 38 | 39 | ynh_backup "/etc/logrotate.d/$app" 40 | 41 | #================================================= 42 | # BACKUP VARIOUS FILES 43 | #================================================= 44 | 45 | ynh_backup "/etc/cron.d/$app" 46 | ynh_backup "/var/log/$app/" 47 | 48 | #================================================= 49 | # BACKUP THE POSTGRESQL DATABASE 50 | #================================================= 51 | ynh_print_info "Backing up the PostgreSQL database..." 52 | 53 | ynh_psql_dump_db > db.sql 54 | 55 | #================================================= 56 | # END OF SCRIPT 57 | #================================================= 58 | 59 | ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." 60 | -------------------------------------------------------------------------------- /conf/local.json: -------------------------------------------------------------------------------- 1 | { 2 | "services": { 3 | "CoAuthoring": { 4 | "server": { 5 | "port": __PORT__ 6 | }, 7 | "sql": { 8 | "type": "postgres", 9 | "dbHost": "127.0.0.1", 10 | "dbPort": "5432", 11 | "dbName": "__DB_NAME__", 12 | "dbUser": "__DB_USER__", 13 | "dbPass": "__DB_PWD__" 14 | }, 15 | "redis": { 16 | "name": "redis", 17 | "prefix": "__APP__:", 18 | "host": "127.0.0.1", 19 | "port": 6379, 20 | "options": { 21 | "database": __REDIS_DB__ 22 | }, 23 | "optionsCluster": {}, 24 | "iooptions": { 25 | "lazyConnect": true 26 | }, 27 | "iooptionsClusterNodes": [], 28 | "iooptionsClusterOptions": { 29 | "lazyConnect": true 30 | } 31 | }, 32 | "request-filtering-agent" : { 33 | "allowPrivateIPAddress": true, 34 | "allowMetaIPAddress": false 35 | }, 36 | "token": { 37 | "enable": { 38 | "request": { 39 | "inbox": true, 40 | "outbox": true 41 | }, 42 | "browser": true 43 | }, 44 | "inbox": { 45 | "header": "Authorization" 46 | }, 47 | "outbox": { 48 | "header": "Authorization" 49 | } 50 | }, 51 | "secret": { 52 | "browser": { 53 | "string": "__JWT_SECRET__" 54 | }, 55 | "inbox": { 56 | "string": "__JWT_SECRET__" 57 | }, 58 | "outbox": { 59 | "string": "__JWT_SECRET__" 60 | }, 61 | "session": { 62 | "string": "__JWT_SECRET__" 63 | } 64 | }, 65 | "autoAssembly": { 66 | "enable": __AUTOASSEMBLY_ENABLE__, 67 | "interval": "__AUTOASSEMBLY_INTERVAL__", 68 | "step": "__AUTOASSEMBLY_STEP__" 69 | }, 70 | "requestDefaults": { 71 | "rejectUnauthorized": __REJECT_UNAUTHORIZED__, 72 | "family": 4 73 | } 74 | } 75 | }, 76 | "storage": { 77 | "fs": { 78 | "secretString": "__SECURE_LINK_SECRET__" 79 | } 80 | }, 81 | "rabbitmq": { 82 | "url": "amqp://__RABBITMQ_USER__:__RABBITMQ_PWD__@localhost/__RABBITMQ_VHOST__" 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 5 | 6 |

7 | Logo of OnlyOffice 8 | OnlyOffice, packaged for YunoHost 9 |

10 | 11 | Create and edit documents collaboratively 12 | 13 | [![🌐 Official app website](https://img.shields.io/badge/Official_app_website-darkgreen?style=for-the-badge)](https://www.onlyoffice.com) 14 | [![App Demo](https://img.shields.io/badge/App_Demo-blue?style=for-the-badge)](https://www.onlyoffice.com/fr/download-desktop.aspx) 15 | [![Version: 9.2.1~ynh1](https://img.shields.io/badge/Version-9.2.1~ynh1-rgb(18,138,11)?style=for-the-badge)](https://ci-apps.yunohost.org/ci/apps/onlyoffice/) 16 | 17 |
18 | 19 | 20 |
21 | 22 | 23 | ## Screenshots 24 | ![Screenshot of OnlyOffice](./doc/screenshots/01-presentation.jpg) 25 | ![Screenshot of OnlyOffice](./doc/screenshots/02-document-short.png) 26 | 27 | ## 📦 Developer info 28 | 29 | [![Automatic tests level](https://apps.yunohost.org/badge/cilevel/onlyoffice)](https://ci-apps.yunohost.org/ci/apps/onlyoffice/) 30 | 31 | 🛠️ Upstream OnlyOffice repository: 32 | 33 | Pull request are welcome and should target the [`testing` branch](https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing). 34 | 35 | The `testing` branch can be tested using: 36 | ``` 37 | # fresh install: 38 | sudo yunohost app install https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing 39 | 40 | # upgrade an existing install: 41 | sudo yunohost app upgrade onlyoffice -u https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing 42 | ``` 43 | 44 | ### 📚 App packaging documentation 45 | 46 | Please see for more information. -------------------------------------------------------------------------------- /conf/docservice.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Docs Docservice 3 | PartOf=__APP__.service 4 | After=network.target syslog.target redis-server.service __APP__-metrics.service __APP__.service 5 | Wants=redis-server.service __APP__-metrics.service 6 | 7 | [Service] 8 | Type=simple 9 | User=__APP__ 10 | Group=__APP__ 11 | WorkingDirectory=__INSTALL_DIR__/documentserver/server/DocService 12 | ExecStart=/bin/sh -c 'exec __INSTALL_DIR__/documentserver/server/DocService/docservice' 13 | ExecStop=__INSTALL_DIR__/bin/documentserver-prepare4shutdown.sh 14 | StandardOutput=append:/var/log/__APP__/docservice.log 15 | StandardError=inherit 16 | Environment=NODE_ENV=production-linux NODE_CONFIG_DIR=__INSTALL_DIR__/config NODE_DISABLE_COLORS=1 APPLICATION_NAME=ONLYOFFICE 17 | 18 | Restart=always 19 | RestartSec=30 20 | 21 | # Give up if ping don't get an answer 22 | TimeoutSec=600 23 | 24 | # Sandboxing options to harden security 25 | # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html 26 | NoNewPrivileges=yes 27 | PrivateTmp=yes 28 | PrivateDevices=yes 29 | RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK 30 | RestrictNamespaces=yes 31 | RestrictRealtime=yes 32 | DevicePolicy=closed 33 | ProtectClock=yes 34 | ProtectHostname=yes 35 | ProtectProc=invisible 36 | ProtectSystem=full 37 | ProtectControlGroups=yes 38 | ProtectKernelModules=yes 39 | ProtectKernelTunables=yes 40 | LockPersonality=yes 41 | SystemCallArchitectures=native 42 | SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged 43 | 44 | # Denying access to capabilities that should not be relevant for webapps 45 | # Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html 46 | CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD 47 | CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE 48 | CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT 49 | CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK 50 | CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM 51 | CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG 52 | CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE 53 | CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW 54 | CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 55 | 56 | 57 | [Install] 58 | WantedBy=__APP__.service 59 | 60 | 61 | -------------------------------------------------------------------------------- /conf/converter.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Docs Converter 3 | PartOf=__APP__.service 4 | After=network.target syslog.target redis-server.service __APP__-metrics.service __APP__.service 5 | Wants=redis-server.service __APP__-metrics.service 6 | 7 | [Service] 8 | Type=simple 9 | User=__APP__ 10 | Group=__APP__ 11 | WorkingDirectory=__INSTALL_DIR__/documentserver/server/FileConverter 12 | ExecStart=/bin/sh -c 'exec __INSTALL_DIR__/documentserver/server/FileConverter/converter' 13 | StandardOutput=append:/var/log/__APP__/converter.log 14 | StandardError=inherit 15 | Environment=NODE_ENV=production-linux NODE_CONFIG_DIR=__INSTALL_DIR__/config NODE_DISABLE_COLORS=1 APPLICATION_NAME=ONLYOFFICE 16 | Environment=LD_LIBRARY_PATH=__INSTALL_DIR__/documentserver/server/FileConverter/bin 17 | 18 | Restart=always 19 | RestartSec=30 20 | 21 | # Give up if ping don't get an answer 22 | TimeoutSec=600 23 | 24 | # Sandboxing options to harden security 25 | # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html 26 | NoNewPrivileges=yes 27 | PrivateTmp=yes 28 | PrivateDevices=yes 29 | RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK 30 | RestrictNamespaces=yes 31 | RestrictRealtime=yes 32 | DevicePolicy=closed 33 | ProtectClock=yes 34 | ProtectHostname=yes 35 | ProtectProc=invisible 36 | ProtectSystem=full 37 | ProtectControlGroups=yes 38 | ProtectKernelModules=yes 39 | ProtectKernelTunables=yes 40 | LockPersonality=yes 41 | SystemCallArchitectures=native 42 | SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged 43 | 44 | # Denying access to capabilities that should not be relevant for webapps 45 | # Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html 46 | CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD 47 | CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE 48 | CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT 49 | CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK 50 | CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM 51 | CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG 52 | CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE 53 | CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW 54 | CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 55 | 56 | [Install] 57 | WantedBy=__APP__.service 58 | 59 | 60 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. 4 | 5 | --- 6 | 7 | **How to post a meaningful bug report** 8 | 1. *Read this whole template first.* 9 | 2. *Determine if you are on the right place:* 10 | - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* 11 | - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* 12 | - *When in doubt, post here and we will figure it out together.* 13 | 3. *Delete the italic comments as you write over them below, and remove this guide.* 14 | --- 15 | 16 | ### Describe the bug 17 | 18 | *A clear and concise description of what the bug is.* 19 | 20 | ### Context 21 | 22 | - Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* 23 | - YunoHost version: x.x.x 24 | - I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* 25 | - Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* 26 | - If yes, please explain: 27 | - Using, or trying to install package version/branch: 28 | - If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* 29 | 30 | ### Steps to reproduce 31 | 32 | - *If you performed a command from the CLI, the command itself is enough. For example:* 33 | ```sh 34 | sudo yunohost app install the_app 35 | ``` 36 | - *If you used the webadmin, please perform the equivalent command from the CLI first.* 37 | - *If the error occurs in your browser, explain what you did:* 38 | 1. *Go to '...'* 39 | 2. *Click on '...'* 40 | 3. *Scroll down to '...'* 41 | 4. *See error* 42 | 43 | ### Expected behavior 44 | 45 | *A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* 46 | 47 | ### Logs 48 | 49 | *When an operation fails, YunoHost provides a simple way to share the logs.* 50 | - *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* 51 | - *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* 52 | 53 | *After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* 54 | 55 | *If applicable and useful, add screenshots to help explain your problem.* 56 | -------------------------------------------------------------------------------- /scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | source _common.sh 8 | source /usr/share/yunohost/helpers 9 | 10 | #================================================= 11 | # INITIALIZE AND STORE SETTINGS 12 | #================================================= 13 | 14 | init_settings 15 | 16 | #================================================= 17 | # DOWNLOAD, CHECK AND UNPACK SOURCE 18 | #================================================= 19 | ynh_script_progression "Setting up source files..." 20 | 21 | setup_sources 22 | 23 | #================================================= 24 | # COMPILE ONLYOFFICE 25 | #================================================= 26 | 27 | if [[ "$rebuild_without_limitations" == "1" ]] ; then 28 | ynh_script_progression "Compiling $app..." 29 | 30 | compile 31 | fi 32 | 33 | #================================================= 34 | # SETUP RABBIT MQ VHOST 35 | #================================================= 36 | ynh_script_progression "Configuring rabbitmq vhost $app..." 37 | 38 | ynh_rabbitmq_setup_vhost 39 | 40 | #================================================= 41 | # SETUP REDIS DB 42 | #================================================= 43 | ynh_script_progression "Configuring redis db..." 44 | 45 | configure_redis 46 | 47 | #================================================= 48 | # APP INITIAL CONFIGURATION 49 | #================================================= 50 | ynh_script_progression "Adding $app's configuration files..." 51 | 52 | ynh_config_add --template="local.json" --destination="$conf_dir/local.json" 53 | chmod 400 "$conf_dir/local.json" 54 | chown "$app:$app" "$conf_dir/local.json" 55 | 56 | #================================================= 57 | # SETUP DATABASE 58 | #================================================= 59 | ynh_script_progression "Populating postgresql database $app..." 60 | 61 | db_dump="$install_dir/documentserver/server/schema/postgresql/createdb.sql" 62 | echo "alter table doc_changes owner to $app;" >> $db_dump 63 | echo "alter table task_result owner to $app;" >> $db_dump 64 | ynh_psql_db_shell $app < "$install_dir/documentserver/server/schema/postgresql/createdb.sql" 65 | 66 | #================================================= 67 | # SYSTEM CONFIGURATION 68 | #================================================= 69 | ynh_script_progression "Adding system configurations related to $app..." 70 | 71 | apply_system_config 72 | 73 | #================================================= 74 | # REGENERATE FONTS AND FLUSH CACHE 75 | #================================================= 76 | ynh_script_progression "Generating fonts and flushing cache..." 77 | 78 | ynh_hide_warnings $install_dir/bin/documentserver-generate-allfonts.sh 79 | 80 | #================================================= 81 | # START SERVICES 82 | #================================================= 83 | 84 | ynh_systemctl --action=start --service="$app" 85 | 86 | #================================================= 87 | # END OF SCRIPT 88 | #================================================= 89 | 90 | ynh_script_progression "Installation of $app completed" 91 | -------------------------------------------------------------------------------- /scripts/restore: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 8 | source ../settings/scripts/_common.sh 9 | source /usr/share/yunohost/helpers 10 | 11 | #================================================= 12 | # RESTORE THE APP MAIN DIR 13 | #================================================= 14 | ynh_script_progression "Restoring the app main directory..." 15 | 16 | ynh_restore "$install_dir" 17 | 18 | set_permissions 19 | 20 | #================================================= 21 | # RESTORE THE DATA DIRECTORY 22 | #================================================= 23 | ynh_script_progression "Restoring the data directory..." 24 | 25 | ynh_restore "$data_dir" 26 | 27 | chown -R $app:www-data "$data_dir" 28 | 29 | #================================================= 30 | # SETUP RABBIT MQ VHOST 31 | #================================================= 32 | ynh_script_progression "Configuring rabbitmq vhost $app..." 33 | 34 | ynh_rabbitmq_setup_vhost 35 | 36 | #================================================= 37 | # SETUP REDIS DB 38 | #================================================= 39 | ynh_script_progression "Configuring redis db..." 40 | 41 | configure_redis 42 | ynh_write_var_in_file --file="$install_dir/config/local.json" --key="database" --value="$redis_db" --after="redis" 43 | ynh_store_file_checksum "$install_dir/config/local.json" 44 | 45 | #================================================= 46 | # RESTORE THE POSTGRESQL DATABASE 47 | #================================================= 48 | ynh_script_progression "Restoring the PostgreSQL database..." 49 | 50 | ynh_psql_db_shell < ./db.sql 51 | 52 | #================================================= 53 | # RESTORE SYSTEM CONFIGURATION 54 | #================================================= 55 | ynh_script_progression "Restoring system configurations related to $app..." 56 | 57 | ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf" 58 | 59 | for service in "converter" "docservice" "metrics"; do 60 | ynh_restore "/etc/systemd/system/$app-$service.service" 61 | done 62 | ynh_restore "/etc/systemd/system/$app.service" 63 | add_services_in_ynh 64 | ynh_restore "/etc/logrotate.d/$app" 65 | 66 | #================================================= 67 | # RESTORE VARIOUS FILES 68 | #================================================= 69 | 70 | ynh_restore "/etc/cron.d/$app" 71 | ynh_restore "/var/log/$app/" 72 | 73 | #================================================= 74 | # REGENERATE FONTS AND FLUSH CACHE 75 | #================================================= 76 | ynh_script_progression "Generating fonts and flushing cache..." 77 | 78 | ynh_hide_warnings $install_dir/bin/documentserver-generate-allfonts.sh 79 | 80 | #================================================= 81 | # START SYSTEMD SERVICE 82 | #================================================= 83 | ynh_script_progression "Starting $app's systemd service..." 84 | 85 | ynh_systemctl --service="$app" --action="start" 86 | 87 | #================================================= 88 | # END OF SCRIPT 89 | #================================================= 90 | 91 | ynh_script_progression "Restoration completed for $app" 92 | -------------------------------------------------------------------------------- /config_panel.toml: -------------------------------------------------------------------------------- 1 | version = "1.0" 2 | 3 | [main] 4 | 5 | [main.integration] 6 | name.en = "Integration" 7 | services = ["nginx", "__APP__-docservice"] 8 | 9 | [main.integration.allowed_urls] 10 | ask.en = "List of web addresses authorized to integrate the OnlyOffice editor separated by space" 11 | ask.fr = "Liste des adresses web autorisées à intégrer l'éditeur OnlyOffice séparées par un espace" 12 | help.en = "Install the OnlyOffice connector to edit documents from Nextcloud." 13 | help.fr = "Installez le connecteur OnlyOffice pour éditer des documents dans Nextcloud." 14 | type = "string" 15 | example = "https://cloud.yunohost.domain/nextcloud https://example.com" 16 | 17 | [main.integration.reject_unauthorized] 18 | ask.en = "Prevent unauthenticated requests" 19 | ask.fr = "Empécher les requêtes non authentifiées" 20 | type = "boolean" 21 | yes = true 22 | no = false 23 | help.en = "In the general case you should keep this option activated. Disabling this option allows OnlyOffice to accept unauthenticated HTTPS requests, which can be useful if your server is not exposed to the internet and cannot obtain a Let's Encrypt certificate." 24 | help.fr = "En général, vous devriez laisser cette option activée. Désactiver cette option permet à OnlyOffice d'accepter les requêtes HTTPS non authentifiées, ce qui peut être utile si votre serveur n'est pas exposé sur internet et ne peut pas obtenir de certificat Let's Encrypt." 25 | bind = "rejectUnauthorized:__INSTALL_DIR__/config/local.json" 26 | 27 | [main.auto_assembly] 28 | name.en = "Automatic forcesaving" 29 | services = ["__APP__-docservice"] 30 | 31 | [main.auto_assembly.autoassembly_enable] 32 | ask.en = "Enable automatic forcesaving" 33 | type = "boolean" 34 | yes = true 35 | no = false 36 | bind = "autoAssembly>enable:__INSTALL_DIR__/config/local.json" 37 | help.en = "The automatic forcesaving will only be initiated after some changes were made to the document. The empty versions will not be forcesaved automatically. Additionally, file versioning needs to be implemented on the document management system's side for this parameter to work." 38 | 39 | [main.auto_assembly.autoassembly_interval] 40 | ask.en = "Interval time in minutes" 41 | type = "string" 42 | bind = "autoAssembly>interval:__INSTALL_DIR__/config/local.json" 43 | help.en = "Defines the interval time in minutes for initiating the automatic forcesaving." 44 | example = "5m" 45 | pattern.regexp = '^\d+m$' 46 | pattern.error = "Provide a value in minutes like '5m'" 47 | 48 | [main.auto_assembly.autoassembly_step] 49 | ask.en = "Delay in minutes between the intervals" 50 | type = "string" 51 | bind = "autoAssembly>step:__INSTALL_DIR__/config/local.json" 52 | example = "1m" 53 | pattern.regexp = '^\d+m$' 54 | pattern.error = "Provide a value in minutes like '1m'" 55 | 56 | [main.rebuild] 57 | name.en = "Limitations" 58 | 59 | [main.rebuild.rebuild_without_limitations] 60 | ask.en = "Remove usage limitations" 61 | ask.fr = "Supprimer les limites d'usage" 62 | type = "boolean" 63 | default = 1 64 | help.en = "Recompile binaries in order to remove usage limitations (number of users, opened documents, smartphone usage). Note: the install and upgrade will be slower. After changing this setting you should trigger a force upgrade of this app by yourself to be effective." 65 | help.fr = "Recompile les binaires afin de supprimer les limitations d'utilisation (nombre d'utilisateurs, documents ouverts, utilisation sur smartphone). NB: l'installation et la mise à jour seront plus lentes. Après avoir modifié ce paramètre, vous devez déclencher vous-même une mise à jour forcée de l'app pour que le changement soit éffectif." 66 | -------------------------------------------------------------------------------- /conf/nginx.conf: -------------------------------------------------------------------------------- 1 | set $secure_link_secret "__SECURE_LINK_SECRET__"; 2 | set $cache_tag "__CACHE_TAG__"; 3 | 4 | client_max_body_size 100m; 5 | underscores_in_headers on; 6 | 7 | proxy_http_version 1.1; 8 | proxy_set_header Upgrade $http_upgrade; 9 | #proxy_set_header Connection $proxy_connection; 10 | proxy_set_header Connection "upgrade"; 11 | proxy_set_header X-Forwarded-Host $server_name; 12 | proxy_set_header X-Forwarded-Proto $scheme; 13 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 14 | proxy_redirect off; 15 | proxy_set_header Host $host; 16 | proxy_set_header X-Real-IP $remote_addr; 17 | 18 | more_set_headers "Content-Security-Policy: frame-ancestors 'self' __ALLOWED_URLS__"; 19 | 20 | #sub_path_only rewrite ^__PATH__$ $scheme://$host__PATH__/welcome/ redirect; 21 | #sub_path_only rewrite ^/cache/files/(?.*)$ $scheme://$host__PATH__/cache/files/$cache redirect; 22 | 23 | #welcome page 24 | rewrite ^__PATH__/$ $scheme://$host__PATH__/welcome/ redirect; 25 | 26 | #script caching protection 27 | # TODO $cache_tag 28 | rewrite ^__PATH__/(?\/web-apps\/apps\/(?!api\/documents\/api\.js$).*)$ $scheme://$host__PATH__/9.0.4-$cache_tag$cache redirect; 29 | 30 | location __PATH__/ { 31 | #disable caching for api.js 32 | location ~ ^(\/[\d]+\.[\d]+\.[\d]+[\.|-][\w]+)?\/(web-apps\/apps\/api\/documents\/api\.js)$ { 33 | expires -1; 34 | # gzip_static on; 35 | alias __INSTALL_DIR__/documentserver/$2; 36 | } 37 | 38 | location ~ ^(\/[\d]+\.[\d]+\.[\d]+[\.|-][\w]+)?\/(document_editor_service_worker.js)$ { 39 | expires 365d; 40 | # gzip_static on; 41 | alias __INSTALL_DIR__/documentserver/sdkjs/common/serviceworker/$2; 42 | } 43 | 44 | #suppress logging the unsupported locale error in web-apps 45 | location ~ ^(\/[\d]+\.[\d]+\.[\d]+[\.|-][\w]+)?\/(web-apps)(\/.*\.json)$ { 46 | expires 365d; 47 | error_log /dev/null crit; 48 | # gzip_static on; 49 | alias __INSTALL_DIR__/documentserver/$2$3; 50 | } 51 | 52 | #suppress logging the unsupported locale error in plugins 53 | location ~ ^(\/[\d]+\.[\d]+\.[\d]+[\.|-][\w]+)?\/(sdkjs-plugins)(\/.*\.json)$ { 54 | expires 365d; 55 | error_log /dev/null crit; 56 | # gzip_static on; 57 | alias __INSTALL_DIR__/documentserver/$2$3; 58 | } 59 | 60 | location ~ ^(\/[\d]+\.[\d]+\.[\d]+[\.|-][\w]+)?\/(web-apps|sdkjs|sdkjs-plugins|fonts|dictionaries)(\/.*)$ { 61 | expires 365d; 62 | # gzip_static on; 63 | alias __INSTALL_DIR__/documentserver/$2$3; 64 | } 65 | 66 | location ~* ^(\/cache\/files.*)(\/.*) { 67 | alias __DATA_DIR__$1; 68 | more_set_headers "Content-Disposition: attachment; filename*=UTF-8''$arg_filename"; 69 | 70 | secure_link $arg_md5,$arg_expires; 71 | secure_link_md5 "$secure_link_expires$uri$secure_link_secret"; 72 | 73 | if ($secure_link = "") { 74 | return 403; 75 | } 76 | 77 | if ($secure_link = "0") { 78 | return 410; 79 | } 80 | } 81 | 82 | # Allow "/internal" interface only from 127.0.0.1 83 | # Don't comment out the section below for the security reason! 84 | location ~* ^(\/[\d]+\.[\d]+\.[\d]+[\.|-][\w]+)?\/(internal)(\/.*)$ { 85 | allow 127.0.0.1; 86 | deny all; 87 | proxy_pass http://localhost:__PORT__/$2$3; 88 | } 89 | 90 | # Allow "/info" interface only from 127.0.0.1 by default 91 | # Comment out lines allow 127.0.0.1; and deny all; 92 | # of below section to turn on the info page 93 | location ~* ^(\/[\d]+\.[\d]+\.[\d]+[\.|-][\w]+)?\/(info)(\/.*)$ { 94 | allow 127.0.0.1; 95 | deny all; 96 | proxy_pass http://localhost:__PORT__/$2$3; 97 | } 98 | 99 | 100 | location ~ ^__PATH__/([\d]+\.[\d]+\.[\d]+[\.|-][\w]+)/(?.*)$ { 101 | proxy_pass http://localhost:__PORT__/$path$is_args$args; 102 | proxy_http_version 1.1; 103 | } 104 | proxy_pass http://localhost:__PORT__/; 105 | 106 | } 107 | -------------------------------------------------------------------------------- /scripts/upgrade: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # IMPORT GENERIC HELPERS 5 | #================================================= 6 | 7 | source _common.sh 8 | source /usr/share/yunohost/helpers 9 | 10 | #================================================= 11 | # STOP SYSTEMD SERVICE 12 | #================================================= 13 | ynh_script_progression "Stopping $app's systemd service..." 14 | 15 | # IMPORTANT: This is not optional, cause this run the routine 16 | # prepare4shutdown and save all the current opened document. 17 | ynh_systemctl --service="$app" --action="stop" 18 | 19 | #================================================= 20 | # ENSURE DOWNWARD COMPATIBILITY 21 | #================================================= 22 | ynh_script_progression "Ensuring downward compatibility..." 23 | 24 | ynh_app_setting_set_default --key=allowed_urls --value="https://${nextclouddomain:-}" 25 | init_settings 26 | 27 | # Remove old install made by .deb 28 | if dpkg-query --show onlyoffice-documentserver &> /dev/null; then 29 | 30 | documentserver-prepare4shutdown.sh 31 | ynh_backup_if_checksum_is_different --file="/etc/onlyoffice/documentserver/default.json" 32 | ynh_backup_if_checksum_is_different --file="/etc/onlyoffice/documentserver/local.json" 33 | _ynh_apt purge onlyoffice-documentserver 34 | ynh_hide_info ynh_safe_rm "/etc/apt/sources.list.d/onlyoffice.list" 35 | ynh_hide_info ynh_safe_rm "/etc/apt/sources.list.d/nodesource.list" 36 | ynh_hide_info ynh_safe_rm "/var/lib/dpkg/info/onlyoffice-documentserver.prerm" 37 | ynh_hide_info ynh_safe_rm "/var/lib/onlyoffice" 38 | ynh_hide_info ynh_safe_rm "/etc/onlyoffice" 39 | 40 | for service in "ds-converter" "ds-docservice" "ds-metrics"; do 41 | if yunohost service status "$service" >/dev/null 2>&1 42 | then 43 | yunohost service remove "$service" 44 | fi 45 | done 46 | fi 47 | 48 | #================================================= 49 | # DOWNLOAD, CHECK AND UNPACK SOURCE 50 | #================================================= 51 | ynh_script_progression "Upgrading OnlyOffice..." 52 | 53 | setup_sources 54 | 55 | #================================================= 56 | # COMPILE ONLYOFFICE 57 | #================================================= 58 | 59 | if [[ "$rebuild_without_limitations" == "1" ]] ; then 60 | ynh_script_progression "Compiling $app..." 61 | 62 | compile 63 | fi 64 | 65 | #================================================= 66 | # SETUP RABBIT MQ VHOST 67 | #================================================= 68 | ynh_script_progression "Configuring rabbitmq vhost $app..." 69 | 70 | ynh_rabbitmq_setup_vhost 71 | 72 | #================================================= 73 | # SETUP REDIS DB 74 | #================================================= 75 | ynh_script_progression "Configuring redis db..." 76 | 77 | configure_redis 78 | 79 | #================================================= 80 | # UPDATE A CONFIG FILE 81 | #================================================= 82 | ynh_script_progression "Updating a configuration file..." 83 | 84 | ynh_config_add --template="local.json" --destination="$conf_dir/local.json" 85 | chmod 400 "$conf_dir/local.json" 86 | chown "$app:$app" "$conf_dir/local.json" 87 | 88 | #================================================= 89 | # REAPPLY SYSTEM CONFIGURATION 90 | #================================================= 91 | ynh_script_progression "Upgrading system configurations related to $app..." 92 | 93 | apply_system_config 94 | 95 | #================================================= 96 | # REGENERATE FONTS AND FLUSH CACHE 97 | #================================================= 98 | ynh_script_progression "Generating fonts and flushing cache..." 99 | 100 | ynh_hide_warnings $install_dir/bin/documentserver-generate-allfonts.sh 101 | 102 | #================================================= 103 | # START SERVICES 104 | #================================================= 105 | 106 | ynh_systemctl --action=restart --service="$app" 107 | 108 | #================================================= 109 | # END OF SCRIPT 110 | #================================================= 111 | 112 | ynh_script_progression "Upgrade of $app completed" 113 | -------------------------------------------------------------------------------- /doc/ADMIN.md: -------------------------------------------------------------------------------- 1 | ## Integrate your ONLYOFFICE Server into an app 2 | 3 | To integrate the editors into your app (nextcloud, seafile, etc.): 4 | 1. Install the dedicated onlyoffice connector extension in your apps 5 | 2. Feed the following settings in the configuration of this extension and save (or restart the app service if it's a config file): 6 | - Address of the Document Server: "https://__DOMAIN____PATH__" 7 | - Secret key: "__JWT_SECRET__" 8 | 3. Test to edit or create a document on your app 9 | 10 | ### Nextcloud 11 | To configure OnlyOffice with Nextcloud: 12 | 13 | - Within Nextcloud, install the ONLYOFFICE app 14 | - go to the settings under "Administration > ONLYOFFICE > Server settings 15 | - Address of the Document Server: "https://__DOMAIN____PATH__" 16 | - Secret key: "__JWT_SECRET__" 17 | 18 | OnlyOffice should now work with your Nextcloud! 19 | 20 | ### Seafile 21 | Add the following config option to `seahub_settings.py`. 22 | ``` 23 | # Enable OnlyOffice 24 | ENABLE_ONLYOFFICE = True 25 | VERIFY_ONLYOFFICE_CERTIFICATE = True 26 | ONLYOFFICE_APIJS_URL = 'https://__DOMAIN____PATH__/web-apps/apps/api/documents/api.js' 27 | ONLYOFFICE_FILE_EXTENSION = ('doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx', 'odt', 'fodt', 'odp', 'fodp', 'ods', 'fods') 28 | ONLYOFFICE_EDIT_FILE_EXTENSION = ('docx', 'pptx', 'xlsx') 29 | 30 | # Enable force save to let user save file when he/she presses the save button on the OnlyOffice file edit page. 31 | ONLYOFFICE_FORCE_SAVE = True 32 | 33 | # if JWT enabled 34 | ONLYOFFICE_JWT_SECRET = '__JWT_SECRET__' 35 | ``` 36 | 37 | Restart seafile 38 | ``` 39 | systemctl restart seafile 40 | systemctl restart seahub 41 | ``` 42 | 43 | ### YesWiki 44 | A yeswiki-extension-documents which supports OnlyOffice exists. 45 | Feel free to contribute if you find a way to set it up. 46 | See https://github.com/YesWiki/yeswiki-extension-documents/blob/main/services/OnlyOfficeDocumentProvider.php 47 | 48 | ### Moodle 49 | If you install Moodle on the same YNH as OnlyOffice, remember to remove 127.0.0.0/8 from curlsecurityblockedhosts (in Site Administration / Security / HTTP Security). 50 | 51 | ### Others 52 | 53 | For Owncloud, Opencloud, Mattermost, Odoo, Moodle, Redmine, Wordpress, Humhub, you can find info on how to integrate OnlyOffice here: https://www.onlyoffice.com/all-connectors.aspx 54 | 55 | 56 | ## Questions & Answers 57 | ### My app doesn't have a valid certificate (local ip). Could I connect it to OnlyOffice ? 58 | Yes, you could do it by deactivating `Prevent unauthenticated requests`. 59 | 60 | Important: it could be a security hole if you can't trust your local router, and your local users... 61 | 62 | ### I am not able to connect my app to this OnlyOffice server 63 | - Check you have a valid Let's Encrypt certificate (https) for your app and this OnlyOffice 64 | - Check your app and the OnlyOffice app are public (so the visitors group should be able to access the app or at least the API...). 65 | - Check your app doesn't contain a mechanism that forbids local request onto 127.0.0.1; if that is the case, you can try to delete `rm /etc/dsnmasq.d/__DOMAIN__` and restart the dnsmasq service `systemctl restart dnsmasq` 66 | 67 | ### Some change on documents are lost 68 | If you use nextcloud client synchronization and OnlyOffice web apps on the same file, you could face sometimes situations where OnlyOffice rewrites a change made from a local device that is synced with the nextcloud client. You probably should adopt a practice with your team to avoid this situation. For example, by adopting a naming convention for collaborative files to open by the web OnlyOffice. 69 | 70 | ### What about the OnlyOffice limitations? Is it legal to remove them like this package did? 71 | OnlyOffice is edited by a company which has decided to integrate strong limitations on their "free software" (like other office apps). Those limitations (20 sessions in the same time) are not easy to understand by end users ("why can't I edit the document???") 72 | 73 | So a way to remove those limitations and to help the editors is to buy a license. 74 | 75 | On the other hand, we know a lot of self hosters don't have enough money to pay expensive licence. 76 | 77 | And, OnlyOffice Document Server is an AGPL v3 software (like YunoHost) and was popularized thanks in part to the fame of this license... AGPLv3 license says we can change the source code if we publish the new source code with the same license (which is what we do here: the patch is under AGPLv3). 78 | 79 | So, as it's legal and a lot of users waited for this, we decided to patch those anti-features. 80 | -------------------------------------------------------------------------------- /patches/src/00-no_limits.patch: -------------------------------------------------------------------------------- 1 | diff --git a/Common/sources/constants.js b/Common/sources/constants.js 2 | index 4fc0d807..cd504b73 100644 3 | --- a/Common/sources/constants.js 4 | +++ b/Common/sources/constants.js 5 | @@ -87,8 +87,8 @@ exports.LICENSE_RESULT = { 6 | NotBefore: 16 7 | }; 8 | 9 | -exports.LICENSE_CONNECTIONS = 20; 10 | -exports.LICENSE_USERS = 3; 11 | +exports.LICENSE_CONNECTIONS = 9999; 12 | +exports.LICENSE_USERS = 200; 13 | exports.LICENSE_EXPIRE_USERS_ONE_DAY = 24 * 60 * 60; // day in seconds 14 | 15 | exports.AVS_OFFICESTUDIO_FILE_UNKNOWN = 0x0000; 16 | diff --git a/Common/sources/license.js b/Common/sources/license.js 17 | index d43ee210..c0f63d4b 100644 18 | --- a/Common/sources/license.js 19 | +++ b/Common/sources/license.js 20 | @@ -45,22 +45,23 @@ 21 | { 22 | count: 1, 23 | type: c_LR.Success, 24 | - packageType: constants.PACKAGE_TYPE_OS, 25 | + packageType: constants.PACKAGE_TYPE_I, 26 | mode: constants.LICENSE_MODE.None, 27 | - branding: false, 28 | + branding: true, 29 | connections: constants.LICENSE_CONNECTIONS, 30 | connectionsView: constants.LICENSE_CONNECTIONS, 31 | - customization: false, 32 | - advancedApi: false, 33 | - usersCount: 0, 34 | - usersViewCount: 0, 35 | + customization: true, 36 | + advancedApi: true, 37 | + usersCount: constants.LICENSE_CONNECTIONS, 38 | + usersViewCount: constants.LICENSE_CONNECTIONS, 39 | usersExpire: constants.LICENSE_EXPIRE_USERS_ONE_DAY, 40 | - hasLicense: false, 41 | + hasLicense: true, 42 | + plugins: true, 43 | buildDate: oBuildDate, 44 | startDate, 45 | - endDate: null, 46 | + endDate: new Date("2099-01-01T23:59:59.000Z"), 47 | customerId: '', 48 | - alias: '', 49 | + alias: 'community', 50 | multitenancy: false 51 | }, 52 | null 53 | ]; 54 | }; 55 | 56 | diff --git a/Common/sources/tenantManager.js b/Common/sources/tenantManager.js 57 | index 703c81d2..898296be 100644 58 | --- a/Common/sources/tenantManager.js 59 | +++ b/Common/sources/tenantManager.js 60 | @@ -304,10 +304,11 @@ async function getTenantLicense(ctx) { 61 | } 62 | res = licenseTupleTenant; 63 | } else { 64 | - res = [...res]; 65 | - res[0] = {...res[0]}; 66 | - res.type = constants.LICENSE_RESULT.Error; 67 | - ctx.logger.error('getTenantLicense error: missing "multitenancy" or "alias" field'); 68 | + // This might need to be changed 69 | + // xbeeant chose to always return a static object, it might break in multitenant mode ? 70 | + // Maybe you can use the generation to retrieve the one defined in license.js [res] = yield* license.readLicense(licensePath); 71 | + // Or it might work just like that. 72 | + res = licenseInfo; 73 | } 74 | } 75 | return res; 76 | diff --git a/DocService/sources/server.js b/DocService/sources/server.js 77 | index 150dca50..3b40b35e 100644 78 | --- a/DocService/sources/server.js 79 | +++ b/DocService/sources/server.js 80 | @@ -124,8 +124,6 @@ if (!(cfgTokenEnableBrowser && cfgTokenEnableRequestInbox && cfgTokenEnableReque 81 | } 82 | 83 | updateLicense(); 84 | -fs.watchFile(cfgLicenseFile, updateLicense); 85 | -setInterval(updateLicense, 86400000); 86 | 87 | try { 88 | let staticContent = config.get('services.CoAuthoring.server.static_content'); 89 | diff --git a/FileConverter/sources/convertermaster.js b/FileConverter/sources/convertermaster.js 90 | index 2209e8c9..37e71847 100644 91 | --- a/FileConverter/sources/convertermaster.js 92 | +++ b/FileConverter/sources/convertermaster.js 93 | @@ -89,9 +89,6 @@ if (cluster.isMaster) { 94 | }); 95 | 96 | updateLicense(); 97 | - 98 | - fs.watchFile(cfgLicenseFile, updateLicense); 99 | - setInterval(updateLicense, 86400000); 100 | } else { 101 | const converter = require('./converter'); 102 | converter.run(); 103 | diff --git a/Makefile b/Makefile 104 | index e8e1308f..23f7e2ef 100644 105 | --- a/Makefile 106 | +++ b/Makefile 107 | @@ -87,7 +87,7 @@ DEBUG = $(BRANDING_DIR)/debug.js 108 | .PHONY: all clean install uninstall build-date 109 | 110 | .NOTPARALLEL: 111 | -all: $(SPELLCHECKER_DICTIONARIES) $(TOOLS) $(SCHEMA) $(CORE_FONTS) $(DOCUMENT_TEMPLATES) $(LICENSE) $(WELCOME) $(INFO) build-date 112 | +all: $(SCHEMA) $(LICENSE) $(WELCOME) $(INFO) build-date 113 | 114 | build-date: $(GRUNT_FILES) 115 | sed "s|\(const buildVersion = \).*|\1'${PRODUCT_VERSION}';|" -i $(COMMON_DEFINES_JS) 116 | 117 | 118 | 119 | -------------------------------------------------------------------------------- /doc/ADMIN_fr.md: -------------------------------------------------------------------------------- 1 | ## Intégrez votre serveur ONLYOFFICE dans une application 2 | 3 | Pour intégrer les éditeurs dans votre application (nextcloud, seafile, etc.) : 4 | 1. Installez l'extension dédiée onlyoffice connector dans vos applications 5 | 2. Effectuez les réglages suivants dans la configuration de cette extension et enregistrez (ou redémarrez le service de l'application s'il s'agit d'un fichier de configuration) : 6 | - Adresse du serveur de documents : « https://__DOMAIN____PATH__ » 7 | - Clé secrète : « __JWT_SECRET__ » 8 | 3. Testez la modification ou la création d'un document sur votre application 9 | 10 | ### Nextcloud 11 | Pour configurer OnlyOffice avec Nextcloud : 12 | 13 | - Dans Nextcloud, installez l'application ONLYOFFICE 14 | - Allez dans les paramètres sous « Administration > ONLYOFFICE > Paramètres du serveur » 15 | - Adresse du serveur de documents : « https://__DOMAIN____PATH__ » 16 | - Clé secrète : « __JWT_SECRET__ » 17 | 18 | OnlyOffice devrait désormais fonctionner avec votre Nextcloud ! 19 | 20 | ### Seafile 21 | Ajouter les paramètres de configuration suivants à `seahub_settings.py` 22 | ``` 23 | # Enable OnlyOffice 24 | ENABLE_ONLYOFFICE = True 25 | VERIFY_ONLYOFFICE_CERTIFICATE = True 26 | ONLYOFFICE_APIJS_URL = 'https://__DOMAIN____PATH__/web-apps/apps/api/documents/api.js' 27 | ONLYOFFICE_FILE_EXTENSION = ('doc', 'docx', 'ppt', 'pptx', 'xls', 'xlsx', 'odt', 'fodt', 'odp', 'fodp', 'ods', 'fods') 28 | ONLYOFFICE_EDIT_FILE_EXTENSION = ('docx', 'pptx', 'xlsx') 29 | 30 | # Enable force save to let user can save file when he/she press the save button on OnlyOffice file edit page. 31 | ONLYOFFICE_FORCE_SAVE = True 32 | 33 | # if JWT enabled 34 | ONLYOFFICE_JWT_SECRET = '__JWT_SECRET__' 35 | ``` 36 | 37 | Restart seafile 38 | ``` 39 | systemctl restart seafile 40 | systemctl restart seahub 41 | ``` 42 | 43 | ### Yeswiki 44 | Une extension existe. 45 | Soyez libre de contribuer si vous trouvez comment l'installer. 46 | Cf: https://github.com/YesWiki/yeswiki-extension-documents/blob/main/services/OnlyOfficeDocumentProvider.php 47 | 48 | ### Moodle 49 | Si on installe Moodle sur le même YNH qu'OnlyOffice, il faut penser à enlever 127.0.0.0/8 de la curlsecurityblockedhosts (in Site Administration / Security / HTTP Security). 50 | 51 | ### Autres 52 | 53 | Pour Owncloud, Opencloud, Mattermost, Odoo, Moodle, Redmine, Wordpress, Humhub, vous pouvez trouver les infos d'intégration ici: https://www.onlyoffice.com/all-connectors.aspx 54 | 55 | ## Questions et Réponses 56 | ### Mes applications ne peuvent pas avoir de certificat valide (adresse IP locale), puis-je les connecter à OnlyOffice ? 57 | Oui, vous pouvez le faire en désactivant l'option « Empêcher les requêtes non authentifiées ». 58 | 59 | Important : cela pourrait constituer une faille de sécurité si vous ne pouvez pas faire confiance à votre routeur local et à vos utilisateurs locaux... 60 | 61 | ### Je ne parviens pas à connecter mon application à ce serveur OnlyOffice 62 | - Vérifiez que vous disposez d'un certificat Let's Encrypt (https) valide pour votre application et ce serveur OnlyOffice 63 | - Vérifiez que votre application et l'application OnlyOffice sont publiques (afin que le groupe de visiteurs puisse accéder à l'application ou au moins à l'API...). 64 | - Vérifiez que votre application ne contient pas de mécanisme interdisant les requêtes locales sur 127.0.0.1. Si c'est le cas, vous pouvez essayer de supprimer `rm /etc/dsnmasq.d/__DOMAIN__` et redémarrer le service dnsmasq `systemctl restart dnsmasq`. 65 | 66 | ### Certaines modifications apportées aux documents sont perdues 67 | Si vous utilisez la synchronisation du client Nextcloud et les applications Web OnlyOffice sur le même fichier, vous pouvez parfois être confronté à des situations où OnlyOffice réécrit une modification effectuée à partir d'un appareil local et la synchronise avec le client Nextcloud. Vous devriez probablement adopter une pratique avec votre équipe pour éviter cette situation. Par exemple, en adoptant une convention de nommage pour les fichiers collaboratifs à ouvrir uniquement via le Web OnlyOffice. 68 | 69 | ### Qu'en est-il des limitations d'OnlyOffice ? Est-il légal de les supprimer comme l'a fait ce package ? 70 | OnlyOffice est édité par une société qui a décidé d'intégrer de fortes limitations à son « logiciel libre » (comme d'autres applications bureautiques). Ces limitations (20 sessions simultanées) ne sont pas faciles à comprendre pour les utilisateurs finaux (« pourquoi je ne peux pas modifier le document ??? »). 71 | 72 | Pour supprimer ces limitations et aider les éditeurs, il faut donc acheter une licence. 73 | 74 | D'un autre côté, nous savons que de nombreux hébergeurs indépendants n'ont pas les moyens de payer une licence coûteuse. 75 | 76 | De plus, OnlyOffice Document Server est un logiciel AGPL v3 (comme YunoHost) qui a été popularisé en partie grâce à la renommée de cette licence... La licence AGPLv3 stipule que nous pouvons modifier le code source si nous publions le nouveau code source sous la même licence (ce que nous faisons ici : le patch est sous AGPLv3). 77 | 78 | Donc, comme c'est légal et que de nombreux utilisateurs l'attendaient, nous avons décidé de corriger ces anti-fonctionnalités. 79 | 80 | -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json 2 | 3 | packaging_format = 2 4 | 5 | id = "onlyoffice" 6 | name = "OnlyOffice" 7 | description.en = "Create and edit documents collaboratively" 8 | description.fr = "Créez et éditer des documents collaborativement" 9 | 10 | version = "9.2.1~ynh1" 11 | 12 | maintainers = [] 13 | 14 | [upstream] 15 | license = "AGPL-3.0-or-later" 16 | website = "https://www.onlyoffice.com" 17 | demo = "https://www.onlyoffice.com/fr/download-desktop.aspx" 18 | code = "https://github.com/ONLYOFFICE/DocumentServer" 19 | cpe = "cpe:2.3:a:onlyoffice:document_server" 20 | 21 | [integration] 22 | yunohost = ">= 12.1.32" 23 | helpers_version = "2.1" 24 | architectures = ["amd64", "arm64"] 25 | multi_instance = true 26 | 27 | ldap = "not_relevant" 28 | sso = "not_relevant" 29 | 30 | disk = "2100M" 31 | ram.build = "800M" 32 | ram.runtime = "800M" 33 | 34 | [antifeatures] 35 | arbitrary-limitations.en = "The official OnlyOffice build limits the number of users and open documents. This package recompiles this part according to the AGPLv3 licence, removing these artificial limitations." 36 | arbitrary-limitations.fr = "La version officielle d'OnlyOffice limite le nombre d'utilisateurs et de documents ouverts. Ce paquet recompile cette partie conformément à la licence AGPLv3, supprimant ainsi ces limitations artificielles." 37 | 38 | [install] 39 | [install.domain] 40 | type = "domain" 41 | 42 | [install.path] 43 | type = "path" 44 | default = "/" 45 | 46 | [install.init_main_permission] 47 | help.en = "You will only be able to connect OnlyOffice to your app if both apps are public!" 48 | help.fr = "Votre app et OnlyOffice doivent être des applications publiques si vous voulez les connecter !" 49 | type = "group" 50 | default = "visitors" 51 | 52 | [install.allowed_urls] 53 | ask.en = "List of web addresses authorized to integrate the OnlyOffice editor separated by space" 54 | ask.fr = "Liste des adresses web autorisées à intégrer l'éditeur OnlyOffice séparées par un espace" 55 | help.en = "Install the OnlyOffice connector to edit documents from Nextcloud." 56 | help.fr = "Installez le connecteur OnlyOffice pour éditer des documents dans Nextcloud." 57 | type = "string" 58 | example = "https://cloud.yunohost.domain/nextcloud https://example.com" 59 | 60 | [install.reject_unauthorized] 61 | ask.en = "Prevent integration with an app that is not authenticated by a valid certificate (example: Let's Encrypt)" 62 | ask.fr = "Empécher l'intégration avec une app non authentifiée par un certificat valide (exemple : Let's Encrypt)" 63 | type = "boolean" 64 | default = true 65 | yes = true 66 | no = false 67 | help.en = "Disabling this option allows OnlyOffice to accept unauthenticated HTTPS requests, which can be useful if your server is not exposed to the internet and cannot obtain a Let's Encrypt certificate." 68 | help.fr = "Désactiver cette option permet à OnlyOffice d'accepter les requêtes HTTPS non authentifiées, ce qui peut être utile si votre serveur n'est pas exposé sur internet et ne peut pas obtenir de certificat Let's Encrypt." 69 | 70 | [install.rebuild_without_limitations] 71 | ask.en = "Remove usage limitations by replacing official OnlyOffice binaries" 72 | ask.fr = "Supprimer les limites d'usage en remplaçant les binaires officiels d'OnlyOffice" 73 | type = "boolean" 74 | default = 1 75 | help.en = "Recompile binaries in order to remove usage limitations (number of users, opened documents, smartphone usage). Note: the install and upgrade will be slower." 76 | help.fr = "Recompile les binaires afin de supprimer les limitations d'utilisation (nombre d'utilisateurs, documents ouverts, utilisation sur smartphone)." 77 | 78 | [resources] 79 | 80 | [resources.sources.main] 81 | amd64.url = "https://github.com/ONLYOFFICE/DocumentServer/releases/download/v9.2.1/onlyoffice-documentserver_amd64.deb" 82 | amd64.sha256 = "fc7ff1d3af4903d32dadf20ba2ce4a453d0828e1ca3ae4bb9c8d59b298b3bef0" 83 | arm64.url = "https://github.com/ONLYOFFICE/DocumentServer/releases/download/v9.2.1/onlyoffice-documentserver_arm64.deb" 84 | arm64.sha256 = "d6148647af2fd9acd14f63ecb615ca8c47a419e92002fd051444ab5caeaf1acd" 85 | extract = false 86 | rename = "onlyoffice-documentserver.deb" 87 | autoupdate.asset.amd64 = "^onlyoffice-documentserver_amd64.deb$" 88 | autoupdate.asset.arm64 = "^onlyoffice-documentserver_arm64.deb$" 89 | autoupdate.strategy = "latest_github_release" 90 | 91 | [resources.sources.src] 92 | url = "https://github.com/ONLYOFFICE/server/archive/refs/tags/v9.1.0.183.tar.gz" 93 | sha256 = "ca41f0e4b05679c813ce840c96553e752fa44f9ec04746fb3ef1e2da239b2945" 94 | # Autoupdater disabled because keeps failing everyday, because no tag found after sanity filtering 95 | # autoupdate.strategy = "latest_github_tag" 96 | # autoupdate.version_regex = "^v9.*$" 97 | # autoupdate.upstream = "https://github.com/ONLYOFFICE/server" 98 | 99 | # [resources.sources.fonts] 100 | # url = "https://forge.liiib.re/indiehost/libre.sh/fonts/-/archive/4f5ad93ee65a862bddfc70eb48ac98e531968da7/fonts-4f5ad93ee65a862bddfc70eb48ac98e531968da7.tar.gz" 101 | # sha256 = "aed831e465bf775320a6298a5a7aac0197754de410f736c1020996267678016f" 102 | 103 | [resources.system_user] 104 | 105 | [resources.install_dir] 106 | group = "www-data:rx" 107 | 108 | [resources.data_dir] 109 | subdirs = ['docbuilder', 'cache/files'] 110 | group = "www-data:rx" 111 | 112 | [resources.permissions] 113 | main.url = "/" 114 | 115 | [resources.ports] 116 | main.default = 8095 117 | 118 | [resources.apt] 119 | packages = [ 120 | "postgresql", 121 | "postgresql-contrib", 122 | "libstdc++6", 123 | "rabbitmq-server", 124 | "redis", 125 | "redis-tools", 126 | "libcurl4-openssl-dev", 127 | "binutils", 128 | #"ttf-mscorefonts-installer", 129 | ] 130 | 131 | [resources.database] 132 | type = "postgresql" 133 | 134 | # [resources.nodejs] 135 | # version = "18" 136 | -------------------------------------------------------------------------------- /scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # COMMON VARIABLES 5 | #================================================= 6 | 7 | conf_dir="$install_dir/config" 8 | nodejs_version="18" 9 | 10 | #================================================= 11 | # PERSONAL HELPERS 12 | #================================================= 13 | init_settings() { 14 | ynh_app_setting_set_default --key=jwt_secret --value="$(ynh_string_random --length=32)" 15 | ynh_app_setting_set_default --key=secure_link_secret --value="$(ynh_string_random)" 16 | ynh_app_setting_set_default --key=autoassembly_enable --value="true" 17 | ynh_app_setting_set_default --key=autoassembly_step --value="1m" 18 | ynh_app_setting_set_default --key=autoassembly_interval --value="3m" 19 | 20 | # ynh_add_config doesn't transform 0 into false and 1 into true... 21 | ynh_app_setting_set_default --key=reject_unauthorized --value="true" 22 | if [[ "$reject_unauthorized" == "0" ]]; then 23 | reject_unauthorized=false 24 | elif [[ "$reject_unauthorized" == "1" ]]; then 25 | reject_unauthorized=true 26 | fi 27 | reject_unauthorized=${reject_unauthorized,,} 28 | # if official_build was set previously, invert the value 29 | official_build=${official_build:-0} 30 | ynh_app_setting_set_default --key=rebuild_without_limitations --value="$((1-official_build))" # true 31 | 32 | # Renew cache tag 33 | cache_tag=$(date +'%Y.%m.%d-%H%M' | openssl md5 | awk '{print $2}') 34 | ynh_app_setting_set --app="$app" --key=cache_tag --value="$cache_tag" 35 | } 36 | 37 | set_permissions() { 38 | chown -R "$app:$app" "$install_dir" 39 | chown "$app:www-data" "$install_dir" 40 | chown "$app:www-data" "$install_dir/documentserver" 41 | chmod go=--- "$install_dir/"{bin,config,Data} 42 | if [ -d "$install_dir/src" ] ; then 43 | chmod go=--- "$install_dir/src" 44 | fi 45 | 46 | chmod o=--- "$install_dir/documentserver" 47 | chmod a-w "$install_dir/documentserver" 48 | if [ -f "$install_dir/config/local.json" ] ; then 49 | chmod 400 "$install_dir/config/local.json" 50 | fi 51 | } 52 | 53 | setup_sources() { 54 | mkdir -p "$install_dir/Data" 55 | mkdir -p "/var/log/$app/" 56 | ynh_hide_info ynh_safe_rm "$install_dir/deb" 57 | ynh_hide_info ynh_safe_rm "$install_dir/src" 58 | ynh_hide_info ynh_safe_rm "$install_dir/bin" 59 | ynh_hide_info ynh_safe_rm "$install_dir/documentserver" 60 | ynh_hide_info ynh_safe_rm "$conf_dir" 61 | mkdir -p "$conf_dir" 62 | ynh_setup_source --dest_dir="$install_dir/deb" 63 | pushd "$install_dir/deb" 64 | ar vx "$install_dir/deb/onlyoffice-documentserver.deb" 65 | 66 | # We use the .deb cause tar.xz doesn't contains submodules and management scripts 67 | tar xf "$install_dir/deb/data.tar.xz" 68 | popd 69 | mv "$install_dir/deb/etc/onlyoffice/documentserver/default.json" "$conf_dir/default.json" 70 | mv "$install_dir/deb/etc/onlyoffice/documentserver/production-linux.json" "$conf_dir/production-linux.json" 71 | mv "$install_dir/deb/etc/onlyoffice/documentserver/log4js" "$conf_dir/log4js" 72 | mv "$install_dir/deb/etc/onlyoffice/documentserver/nginx" "$conf_dir/nginx" 73 | mv "$install_dir/deb/var/www/onlyoffice/documentserver" "$install_dir/documentserver" 74 | mv "$install_dir/deb/usr/bin" "$install_dir/bin" 75 | mkdir -p "$install_dir/documentserver/fonts" 76 | ynh_safe_rm "$install_dir/deb" 77 | 78 | # We use sources in order to recompile binary 79 | if [[ "$rebuild_without_limitations" == "1" ]] ; then 80 | ynh_setup_source --source_id="src" --dest_dir="$install_dir/src" 81 | ynh_replace --match="const buildVersion = " --replace="const buildVersion = '${YNH_APP_MANIFEST_VERSION%%~*}';" --file="$install_dir/src/Common/sources/commondefines.js" 82 | buildNumber=$(ynh_read_manifest "resources.sources.src.url"| sed "s/\.tar\.gz//" | grep -Eo "[0-9]+$") 83 | ynh_replace --match="const buildNumber = " --replace="const buildNumber = $buildNumber;" --file="$install_dir/src/Common/sources/commondefines.js" 84 | ynh_replace --match="const buildDate = " --replace="const buildDate = '$( date +%F )';" --file="$install_dir/src/Common/sources/license.js" 85 | fi 86 | set_permissions 87 | 88 | #ynh_setup_source --source_id="fonts" --dest_dir="/usr/share/fonts/custom/" 89 | 90 | # Some config an scripts should be patched in order to support 91 | # ynh files and port organisation 92 | ynh_replace --match="/var/www/onlyoffice/" --replace="$install_dir/" --file="$conf_dir/production-linux.json" 93 | ynh_replace --match="/etc/onlyoffice/documentserver/" --replace="$install_dir/config/" --file="$conf_dir/production-linux.json" 94 | ynh_replace --match="/var/lib/onlyoffice/documentserver/App_Data/" --replace="$data_dir/" --file="$conf_dir/production-linux.json" 95 | ynh_store_file_checksum "$conf_dir/production-linux.json" 96 | 97 | # Hack for documentserver script 98 | for script in $(ls "$install_dir/bin/") 99 | do 100 | ynh_replace --match="/var/www/onlyoffice/" --replace="$install_dir/" --file="$install_dir/bin/$script" 101 | ynh_replace --match="/etc/onlyoffice/documentserver" --replace="$conf_dir" --file="$install_dir/bin/$script" 102 | ynh_replace --match="ds:ds" --replace="$app:$app" --file="$install_dir/bin/$script" 103 | ynh_replace --match="ds-docservice" --replace="$app-docservice" --file="$install_dir/bin/$script" 104 | ynh_replace --match="ds-converter" --replace="$app-converter" --file="$install_dir/bin/$script" 105 | done 106 | ynh_replace --match="localhost:8000" --replace="localhost:$port" --file="$install_dir/bin/documentserver-prepare4shutdown.sh" 107 | 108 | ynh_replace --match=".*/etc/nginx/includes/ds-cache.conf.*" --replace='sed "/set $cache_tag /s/.*/set \$cache_tag \"$HASH\";/" /etc/nginx/conf.d/'$domain'.d/'$app'.conf' --file="$install_dir/bin/documentserver-flush-cache.sh" 109 | ynh_replace --match="documentserver-flush-cache.sh" --replace="$install_dir/bin/documentserver-flush-cache.sh" --file="$install_dir/bin/documentserver-generate-allfonts.sh" 110 | ynh_hide_info ynh_safe_rm "$conf_dir/nginx/ds.conf" 111 | ln -s /etc/nginx/conf.d/$domain.d/$app.conf "$conf_dir/nginx/ds.conf" 112 | ynh_hide_info ynh_safe_rm "$conf_dir/nginx/includes/ds-docservice.conf" 113 | ln -s /etc/nginx/conf.d/$domain.d/$app.conf "$conf_dir/nginx/includes/ds-docservice.conf" 114 | } 115 | 116 | compile() { 117 | ynh_nodejs_install 118 | pushd "$install_dir" 119 | ynh_hide_warnings npm install @yao-pkg/pkg 120 | popd 121 | pushd "$install_dir/src" 122 | ynh_hide_warnings npm ci 123 | ynh_hide_warnings npm run build 124 | 125 | ynh_hide_warnings ../node_modules/.bin/pkg DocService --options max_old_space_size=4096 -o $install_dir/documentserver/server/DocService/docservice 126 | ynh_hide_warnings ../node_modules/.bin/pkg FileConverter -o $install_dir/documentserver/server/FileConverter/converter 127 | ynh_hide_warnings ../node_modules/.bin/pkg Metrics -o $install_dir/documentserver/server/Metrics/metrics 128 | popd 129 | 130 | # Activate smartphone editor 131 | sed -i 's/isSupportEditFeature=()=>!1/isSupportEditFeature=()=>!0/g' $install_dir/documentserver/web-apps/apps/*/mobile/dist/js/app.js 132 | 133 | # Avoid taking up space unnecessarily 134 | ynh_hide_info ynh_safe_rm "$install_dir/src" 135 | } 136 | 137 | add_services_in_ynh() { 138 | for service in "converter" "docservice" "metrics"; do 139 | systemctl enable "$app-$service.service" --quiet 140 | yunohost service add "$app-$service" --description="$app $service" --log="/var/log/$app/$service.log" 141 | done 142 | systemctl enable "$app.service" --quiet 143 | yunohost service add "$app" --description="$app" --test_status="systemctl is-active $app-docservice $app-converter |uniq" 144 | } 145 | 146 | apply_system_config() { 147 | # Create a dedicated NGINX config using the conf/nginx.conf template 148 | ynh_config_add_nginx 149 | 150 | # Create a dedicated systemd config 151 | ynh_config_add_systemd --service="$app" 152 | for service in "converter" "docservice" "metrics"; do 153 | ynh_config_add_systemd --service="$app-$service" --template="$service.service" 154 | done 155 | add_services_in_ynh 156 | chown -R "$app:$app" "/var/log/$app/" 157 | 158 | # Use logrotate to manage application logfile(s) 159 | ynh_config_add_logrotate 160 | 161 | # This is not in official setup but it could help to avoid overload and lost data 162 | # It runs a restart which triggers document-prepare4shutdown.sh script (in ExecStop) so all documents are force saved and all clients disconnected. 163 | # Note: may be the autoAssembly config is enough, and that's not necessary anymore. 164 | ynh_config_add --template="cron" --destination="/etc/cron.d/$app" 165 | 166 | } 167 | 168 | configure_redis() { 169 | redis_db=$(ynh_app_setting_get --app="$app" --key=redis_db) 170 | if [[ "$redis_db" == "" ]]; then 171 | redis_db=$(ynh_redis_get_free_db) 172 | ynh_app_setting_set --app="$app" --key=redis_db --value="$redis_db" 173 | fi 174 | } 175 | 176 | #================================================= 177 | # EXPERIMENTAL HELPERS 178 | #================================================= 179 | 180 | ynh_rabbitmq_setup_vhost() { 181 | ynh_hide_warnings rabbitmqctl delete_user "guest" || true 182 | rabbitmq_user=$app 183 | rabbitmq_vhost=$app 184 | rabbitmq_pwd=$(ynh_app_setting_get --app="$app" --key=rabbitmq_pwd) 185 | rabbitmq_pwd=${rabbitmq_pwd:-$(ynh_string_random)} 186 | ynh_app_setting_set --app="$app" --key=rabbitmq_user --value="$rabbitmq_user" 187 | ynh_app_setting_set --app="$app" --key=rabbitmq_vhost --value="$rabbitmq_vhost" 188 | ynh_app_setting_set --app="$app" --key=rabbitmq_pwd --value="$rabbitmq_pwd" 189 | ynh_hide_warnings rabbitmqctl add_user "$rabbitmq_user" "$rabbitmq_pwd" || true 190 | rabbitmqctl set_user_tags "$rabbitmq_user" administrator || true 191 | rabbitmqctl add_vhost "$rabbitmq_vhost" || true 192 | rabbitmqctl set_permissions -p "$rabbitmq_vhost" "$rabbitmq_user" ".*" ".*" ".*" 193 | } 194 | 195 | ynh_rabbitmq_remove_vhost() { 196 | rabbitmqctl delete_user "$rabbitmq_user" 197 | rabbitmqctl delete_vhost "$rabbitmq_vhost" 198 | } 199 | 200 | ynh_hide_info() { 201 | OLD_YNH_STDINFO=$YNH_STDINFO 202 | YNH_STDINFO=/dev/null 203 | # Note that "$@" is used and not $@, c.f. https://unix.stackexchange.com/a/129077 204 | "$@" 205 | YNH_STDINFO=$OLD_YNH_STDINFO 206 | } 207 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------