├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── .gitignore ├── ALL_README.md ├── LICENSE ├── README.md ├── README_ca.md ├── README_de.md ├── README_es.md ├── README_eu.md ├── README_fr.md ├── README_gl.md ├── README_id.md ├── README_nl.md ├── README_pl.md ├── README_ru.md ├── README_zh_Hans.md ├── conf ├── config.js ├── nginx-sandbox.conf ├── nginx-shared.conf ├── nginx.conf └── systemd.service ├── doc ├── ADMIN.md ├── ADMIN_fr.md ├── DESCRIPTION.md ├── DESCRIPTION_fr.md ├── POST_INSTALL.md ├── POST_INSTALL_fr.md ├── POST_UPGRADE.d │ └── 2024.9.1~ynh1.md ├── POST_UPGRADE.md ├── POST_UPGRADE_fr.md └── screenshots │ └── screenshot.png ├── hooks ├── cert_alternate_names └── custom_dns_rules ├── manifest.toml ├── scripts ├── _common.sh ├── backup ├── change_url ├── install ├── remove ├── restore └── upgrade └── tests.toml /.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 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *.sw[op] 3 | .DS_Store 4 | -------------------------------------------------------------------------------- /ALL_README.md: -------------------------------------------------------------------------------- 1 | # All available README files by language 2 | 3 | - [Read the README in English](README.md) 4 | - [Llegir el README en català](README_ca.md) 5 | - [Die README in Deutsch lesen](README_de.md) 6 | - [Lea el README en español](README_es.md) 7 | - [Irakurri README euskaraz](README_eu.md) 8 | - [Lire le README en français](README_fr.md) 9 | - [Le o README en galego](README_gl.md) 10 | - [Baca README dalam bahasa bahasa Indonesia](README_id.md) 11 | - [Lees de README in het Nederlands](README_nl.md) 12 | - [Przeczytaj README w języku polski](README_pl.md) 13 | - [Прочитать README на русский](README_ru.md) 14 | - [阅读中文（简体）的 README](README_zh_Hans.md) 15 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad for YunoHost 7 | 8 | [![Integration level](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Working status](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Maintenance status](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Install CryptPad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Read this README in other languages.](./ALL_README.md)* 15 | 16 | > *This package allows you to install CryptPad quickly and simply on a YunoHost server.* 17 | > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.* 18 | 19 | ## Overview 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Shipped version:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Screenshots 28 | 29 | ![Screenshot of CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Documentation and resources 32 | 33 | - Official app website: 34 | - Official admin documentation: 35 | - Upstream app code repository: 36 | - YunoHost Store: 37 | - Report a bug: 38 | 39 | ## Developer info 40 | 41 | Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | To try the `testing` branch, please proceed like that: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | or 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **More info regarding app packaging:** 52 | -------------------------------------------------------------------------------- /README_ca.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad per YunoHost 7 | 8 | [![Nivell d'integració](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Estat de funcionament](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Estat de manteniment](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Instal·la CryptPad amb YunoHosth](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Llegeix aquest README en altres idiomes.](./ALL_README.md)* 15 | 16 | > *Aquest paquet et permet instal·lar CryptPad de forma ràpida i senzilla en un servidor YunoHost.* 17 | > *Si no tens YunoHost, consulta [la guia](https://yunohost.org/install) per saber com instal·lar-lo.* 18 | 19 | ## Visió general 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Versió inclosa:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Captures de pantalla 28 | 29 | ![Captures de pantalla de CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Documentació i recursos 32 | 33 | - Lloc web oficial de l'aplicació: 34 | - Documentació oficial per l'administrador: 35 | - Repositori oficial del codi de l'aplicació: 36 | - Botiga YunoHost: 37 | - Reportar un error: 38 | 39 | ## Informació per a desenvolupadors 40 | 41 | Envieu les pull request a la [branca `testing`](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Per provar la branca `testing`, procedir com descrit a continuació: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | o 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Més informació sobre l'empaquetatge d'aplicacions:** 52 | -------------------------------------------------------------------------------- /README_de.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad für YunoHost 7 | 8 | [![Integrations-Level](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Funktionsstatus](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Wartungsstatus](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![CryptPad mit YunoHost installieren](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Dieses README in anderen Sprachen lesen.](./ALL_README.md)* 15 | 16 | > *Mit diesem Paket können Sie CryptPad schnell und einfach auf einem YunoHost-Server installieren.* 17 | > *Wenn Sie YunoHost nicht haben, lesen Sie bitte [die Anleitung](https://yunohost.org/install), um zu erfahren, wie Sie es installieren.* 18 | 19 | ## Übersicht 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Ausgelieferte Version:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Bildschirmfotos 28 | 29 | ![Bildschirmfotos von CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Dokumentation und Ressourcen 32 | 33 | - Offizielle Website der App: 34 | - Offizielle Verwaltungsdokumentation: 35 | - Upstream App Repository: 36 | - YunoHost-Shop: 37 | - Einen Fehler melden: 38 | 39 | ## Entwicklerinformationen 40 | 41 | Bitte senden Sie Ihren Pull-Request an den [`testing` branch](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Um den `testing` Branch auszuprobieren, gehen Sie bitte wie folgt vor: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | oder 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Weitere Informationen zur App-Paketierung:** 52 | -------------------------------------------------------------------------------- /README_es.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad para YunoHost 7 | 8 | [![Nivel de integración](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Estado funcional](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Estado En Mantención](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Instalar CryptPad con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Leer este README en otros idiomas.](./ALL_README.md)* 15 | 16 | > *Este paquete le permite instalarCryptPad rapidamente y simplement en un servidor YunoHost.* 17 | > *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.* 18 | 19 | ## Descripción general 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Versión actual:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Capturas 28 | 29 | ![Captura de CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Documentaciones y recursos 32 | 33 | - Sitio web oficial: 34 | - Documentación administrador oficial: 35 | - Repositorio del código fuente oficial de la aplicación : 36 | - Catálogo YunoHost: 37 | - Reportar un error: 38 | 39 | ## Información para desarrolladores 40 | 41 | Por favor enviar sus correcciones a la [rama `testing`](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Para probar la rama `testing`, sigue asÍ: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | o 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Mas informaciones sobre el empaquetado de aplicaciones:** 52 | -------------------------------------------------------------------------------- /README_eu.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad YunoHost-erako 7 | 8 | [![Integrazio maila](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Funtzionamendu egoera](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Mantentze egoera](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Instalatu CryptPad YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* 15 | 16 | > *Pakete honek CryptPad YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* 17 | > *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* 18 | 19 | ## Aurreikuspena 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Paketatutako bertsioa:** 2025.3.0~ynh1 24 | 25 | **Demoa:** 26 | 27 | ## Pantaila-argazkiak 28 | 29 | ![CryptPad(r)en pantaila-argazkia](./doc/screenshots/screenshot.png) 30 | 31 | ## Dokumentazioa eta baliabideak 32 | 33 | - Aplikazioaren webgune ofiziala: 34 | - Administratzaileen dokumentazio ofiziala: 35 | - Jatorrizko aplikazioaren kode-gordailua: 36 | - YunoHost Denda: 37 | - Eman errore baten berri: 38 | 39 | ## Garatzaileentzako informazioa 40 | 41 | Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | `testing` abarra probatzeko, honakoa egin: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | edo 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Informazio gehiago aplikazioaren paketatzeari buruz:** 52 | -------------------------------------------------------------------------------- /README_fr.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad pour YunoHost 7 | 8 | [![Niveau d’intégration](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Statut du fonctionnement](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Statut de maintenance](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Installer CryptPad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Lire le README dans d'autres langues.](./ALL_README.md)* 15 | 16 | > *Ce package vous permet d’installer CryptPad rapidement et simplement sur un serveur YunoHost.* 17 | > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* 18 | 19 | ## Vue d’ensemble 20 | 21 | CryptPad est une suite de collaboration chiffrée de bout en bout et open source. Il est conçu pour permettre la collaboration, en synchronisant les modifications apportées aux documents en temps réel. Étant donné que toutes les données sont chiffrées, le service et ses administrateurs n'ont aucun moyen de voir le contenu modifié et stocké. 22 | 23 | **Version incluse :** 2025.3.0~ynh1 24 | 25 | **Démo :** 26 | 27 | ## Captures d’écran 28 | 29 | ![Capture d’écran de CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Documentations et ressources 32 | 33 | - Site officiel de l’app : 34 | - Documentation officielle de l’admin : 35 | - Dépôt de code officiel de l’app : 36 | - YunoHost Store : 37 | - Signaler un bug : 38 | 39 | ## Informations pour les développeurs 40 | 41 | Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Pour essayer la branche `testing`, procédez comme suit : 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | ou 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Plus d’infos sur le packaging d’applications :** 52 | -------------------------------------------------------------------------------- /README_gl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad para YunoHost 7 | 8 | [![Nivel de integración](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Estado de funcionamento](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Estado de mantemento](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Instalar CryptPad con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Le este README en outros idiomas.](./ALL_README.md)* 15 | 16 | > *Este paquete permíteche instalar CryptPad de xeito rápido e doado nun servidor YunoHost.* 17 | > *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* 18 | 19 | ## Vista xeral 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Versión proporcionada:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Capturas de pantalla 28 | 29 | ![Captura de pantalla de CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Documentación e recursos 32 | 33 | - Web oficial da app: 34 | - Documentación oficial para admin: 35 | - Repositorio de orixe do código: 36 | - Tenda YunoHost: 37 | - Informar dun problema: 38 | 39 | ## Info de desenvolvemento 40 | 41 | Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Para probar a rama `testing`, procede deste xeito: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | ou 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Máis info sobre o empaquetado da app:** 52 | -------------------------------------------------------------------------------- /README_id.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad untuk YunoHost 7 | 8 | [![Tingkat integrasi](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Status kerja](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Status pemeliharaan](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Pasang CryptPad dengan YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Baca README ini dengan bahasa yang lain.](./ALL_README.md)* 15 | 16 | > *Paket ini memperbolehkan Anda untuk memasang CryptPad secara cepat dan mudah pada server YunoHost.* 17 | > *Bila Anda tidak mempunyai YunoHost, silakan berkonsultasi dengan [panduan](https://yunohost.org/install) untuk mempelajari bagaimana untuk memasangnya.* 18 | 19 | ## Ringkasan 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Versi terkirim:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Tangkapan Layar 28 | 29 | ![Tangkapan Layar pada CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Dokumentasi dan sumber daya 32 | 33 | - Website aplikasi resmi: 34 | - Dokumentasi admin resmi: 35 | - Depot kode aplikasi hulu: 36 | - Gudang YunoHost: 37 | - Laporkan bug: 38 | 39 | ## Info developer 40 | 41 | Silakan kirim pull request ke [`testing` branch](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Untuk mencoba branch `testing`, silakan dilanjutkan seperti: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | atau 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Info lebih lanjut mengenai pemaketan aplikasi:** 52 | -------------------------------------------------------------------------------- /README_nl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad voor Yunohost 7 | 8 | [![Integratieniveau](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Mate van functioneren](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Onderhoudsstatus](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![CryptPad met Yunohost installeren](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Deze README in een andere taal lezen.](./ALL_README.md)* 15 | 16 | > *Met dit pakket kun je CryptPad snel en eenvoudig op een YunoHost-server installeren.* 17 | > *Als je nog geen YunoHost hebt, lees dan [de installatiehandleiding](https://yunohost.org/install), om te zien hoe je 'm installeert.* 18 | 19 | ## Overzicht 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Geleverde versie:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Schermafdrukken 28 | 29 | ![Schermafdrukken van CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Documentatie en bronnen 32 | 33 | - Officiele website van de app: 34 | - Officiele beheerdersdocumentatie: 35 | - Upstream app codedepot: 36 | - YunoHost-store: 37 | - Meld een bug: 38 | 39 | ## Ontwikkelaarsinformatie 40 | 41 | Stuur je pull request alsjeblieft naar de [`testing`-branch](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Om de `testing`-branch uit te proberen, ga als volgt te werk: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | of 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Verdere informatie over app-packaging:** 52 | -------------------------------------------------------------------------------- /README_pl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad dla YunoHost 7 | 8 | [![Poziom integracji](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Status działania](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Status utrzymania](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Zainstaluj CryptPad z YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Przeczytaj plik README w innym języku.](./ALL_README.md)* 15 | 16 | > *Ta aplikacja pozwala na szybką i prostą instalację CryptPad na serwerze YunoHost.* 17 | > *Jeżeli nie masz YunoHost zapoznaj się z [poradnikiem](https://yunohost.org/install) instalacji.* 18 | 19 | ## Przegląd 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Dostarczona wersja:** 2025.3.0~ynh1 24 | 25 | **Demo:** 26 | 27 | ## Zrzuty ekranu 28 | 29 | ![Zrzut ekranu z CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Dokumentacja i zasoby 32 | 33 | - Oficjalna strona aplikacji: 34 | - Oficjalna dokumentacja dla administratora: 35 | - Repozytorium z kodem źródłowym: 36 | - Sklep YunoHost: 37 | - Zgłaszanie błędów: 38 | 39 | ## Informacje od twórców 40 | 41 | Wyślij swój pull request do [gałęzi `testing`](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Aby wypróbować gałąź `testing` postępuj zgodnie z instrukcjami: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | lub 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Więcej informacji o tworzeniu paczek aplikacji:** 52 | -------------------------------------------------------------------------------- /README_ru.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # CryptPad для YunoHost 7 | 8 | [![Уровень интеграции](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![Состояние работы](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![Состояние сопровождения](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![Установите CryptPad с YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[Прочтите этот README на других языках.](./ALL_README.md)* 15 | 16 | > *Этот пакет позволяет Вам установить CryptPad быстро и просто на YunoHost-сервер.* 17 | > *Если у Вас нет YunoHost, пожалуйста, посмотрите [инструкцию](https://yunohost.org/install), чтобы узнать, как установить его.* 18 | 19 | ## Обзор 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **Поставляемая версия:** 2025.3.0~ynh1 24 | 25 | **Демо-версия:** 26 | 27 | ## Снимки экрана 28 | 29 | ![Снимок экрана CryptPad](./doc/screenshots/screenshot.png) 30 | 31 | ## Документация и ресурсы 32 | 33 | - Официальный веб-сайт приложения: 34 | - Официальная документация администратора: 35 | - Репозиторий кода главной ветки приложения: 36 | - Магазин YunoHost: 37 | - Сообщите об ошибке: 38 | 39 | ## Информация для разработчиков 40 | 41 | Пришлите Ваш запрос на слияние в [ветку `testing`](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing). 42 | 43 | Чтобы попробовать ветку `testing`, пожалуйста, сделайте что-то вроде этого: 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | или 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **Больше информации о пакетировании приложений:** 52 | -------------------------------------------------------------------------------- /README_zh_Hans.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # YunoHost 上的 CryptPad 7 | 8 | [![集成程度](https://apps.yunohost.org/badge/integration/cryptpad)](https://ci-apps.yunohost.org/ci/apps/cryptpad/) 9 | ![工作状态](https://apps.yunohost.org/badge/state/cryptpad) 10 | ![维护状态](https://apps.yunohost.org/badge/maintained/cryptpad) 11 | 12 | [![使用 YunoHost 安装 CryptPad](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=cryptpad) 13 | 14 | *[阅读此 README 的其它语言版本。](./ALL_README.md)* 15 | 16 | > *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 CryptPad。* 17 | > *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* 18 | 19 | ## 概况 20 | 21 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. 22 | 23 | **分发版本：** 2025.3.0~ynh1 24 | 25 | **演示：** 26 | 27 | ## 截图 28 | 29 | ![CryptPad 的截图](./doc/screenshots/screenshot.png) 30 | 31 | ## 文档与资源 32 | 33 | - 官方应用网站： 34 | - 官方管理文档： 35 | - 上游应用代码库： 36 | - YunoHost 商店： 37 | - 报告 bug： 38 | 39 | ## 开发者信息 40 | 41 | 请向 [`testing` 分支](https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing) 发送拉取请求。 42 | 43 | 如要尝试 `testing` 分支，请这样操作： 44 | 45 | ```bash 46 | sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 47 | 或 48 | sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug 49 | ``` 50 | 51 | **有关应用打包的更多信息：** 52 | -------------------------------------------------------------------------------- /conf/config.js: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: 2023 XWiki CryptPad Team and contributors 2 | // 3 | // SPDX-License-Identifier: AGPL-3.0-or-later 4 | 5 | /* globals module */ 6 | 7 | /* DISCLAIMER: 8 | 9 | There are two recommended methods of running a CryptPad instance: 10 | 11 | 1. Using a standalone nodejs server without HTTPS (suitable for local development) 12 | 2. Using NGINX to serve static assets and to handle HTTPS for API server's websocket traffic 13 | 14 | We do not officially recommend or support Apache, Docker, Kubernetes, Traefik, or any other configuration. 15 | Support requests for such setups should be directed to their authors. 16 | 17 | If you're having difficulty difficulty configuring your instance 18 | we suggest that you join the project's Matrix channel. 19 | 20 | If you don't have any difficulty configuring your instance and you'd like to 21 | support us for the work that went into making it pain-free we are quite happy 22 | to accept donations via our opencollective page: https://opencollective.com/cryptpad 23 | 24 | */ 25 | module.exports = { 26 | /* CryptPad is designed to serve its content over two domains. 27 | * Account passwords and cryptographic content is handled on the 'main' domain, 28 | * while the user interface is loaded on a 'sandbox' domain 29 | * which can only access information which the main domain willingly shares. 30 | * 31 | * In the event of an XSS vulnerability in the UI (that's bad) 32 | * this system prevents attackers from gaining access to your account (that's good). 33 | * 34 | * Most problems with new instances are related to this system blocking access 35 | * because of incorrectly configured sandboxes. If you only see a white screen 36 | * when you try to load CryptPad, this is probably the cause. 37 | * 38 | * PLEASE READ THE FOLLOWING COMMENTS CAREFULLY. 39 | * 40 | */ 41 | 42 | /* httpUnsafeOrigin is the URL that clients will enter to load your instance. 43 | * Any other URL that somehow points to your instance is supposed to be blocked. 44 | * The default provided below assumes you are loading CryptPad from a server 45 | * which is running on the same machine, using port 3000. 46 | * 47 | * In a production instance this should be available ONLY over HTTPS 48 | * using the default port for HTTPS (443) ie. https://cryptpad.fr 49 | * In such a case this should be also handled by NGINX, as documented in 50 | * cryptpad/docs/example.nginx.conf (see the $main_domain variable) 51 | * 52 | */ 53 | httpUnsafeOrigin: 'https://__DOMAIN__', 54 | 55 | /* httpSafeOrigin is the URL that is used for the 'sandbox' described above. 56 | * If you're testing or developing with CryptPad on your local machine then 57 | * it is appropriate to leave this blank. The default behaviour is to serve 58 | * the main domain over port 3000 and to serve the sandbox content over port 3001. 59 | * 60 | * This is not appropriate in a production environment where invasive networks 61 | * may filter traffic going over abnormal ports. 62 | * To correctly configure your production instance you must provide a URL 63 | * with a different domain (a subdomain is sufficient). 64 | * It will be used to load the UI in our 'sandbox' system. 65 | * 66 | * This value corresponds to the $sandbox_domain variable 67 | * in the example nginx file. 68 | * 69 | * Note that in order for the sandboxing system to be effective 70 | * httpSafeOrigin must be different from httpUnsafeOrigin. 71 | * 72 | * CUSTOMIZE AND UNCOMMENT THIS FOR PRODUCTION INSTALLATIONS. 73 | */ 74 | httpSafeOrigin: "https://__SANDBOXDOMAIN__", 75 | 76 | /* httpAddress specifies the address on which the nodejs server 77 | * should be accessible. By default it will listen on localhost 78 | * (IPv4 & IPv6 if enabled). If you want it to listen on 79 | * a specific address, specify it here. e.g '192.168.0.1' 80 | * 81 | */ 82 | httpAddress: '127.0.0.1', 83 | 84 | /* httpPort specifies on which port the nodejs server should listen. 85 | * By default it will serve content over port 3000, which is suitable 86 | * for both local development and for use with the provided nginx example, 87 | * which will proxy websocket traffic to your node server. 88 | * 89 | */ 90 | httpPort: __PORT__, 91 | 92 | /* httpSafePort allows you to specify an alternative port from which 93 | * the node process should serve sandboxed assets. The default value is 94 | * that of your httpPort + 1. You probably don't need to change this. 95 | * 96 | */ 97 | // httpSafePort: 3001, 98 | 99 | /* Websockets need to be exposed on a separate port from the rest of 100 | * the platform's HTTP traffic. Port 3003 is used by default. 101 | * You can change this to a different port if it is in use by a 102 | * different service, but under most circumstances you can leave this 103 | * commented and it will work. 104 | * 105 | * In production environments, your reverse proxy (usually NGINX) 106 | * will need to forward websocket traffic (/cryptpad_websocket) 107 | * to this port. 108 | * 109 | */ 110 | websocketPort: __PORT_SOCKET__, 111 | 112 | /* CryptPad will launch a child process for every core available 113 | * in order to perform CPU-intensive tasks in parallel. 114 | * Some host environments may have a very large number of cores available 115 | * or you may want to limit how much computing power CryptPad can take. 116 | * If so, set 'maxWorkers' to a positive integer. 117 | */ 118 | // maxWorkers: 4, 119 | 120 | /* ===================== 121 | * Sessions 122 | * ===================== */ 123 | 124 | /* Accounts can be protected with an OTP (One Time Password) system 125 | * to add a second authentication layer. Such accounts use a session 126 | * with a given lifetime after which they are logged out and need 127 | * to be re-authenticated. You can configure the lifetime of these 128 | * sessions here. 129 | * 130 | * defaults to 7 days 131 | */ 132 | //otpSessionExpiration: 7*24, // hours 133 | 134 | /* Registered users can be forced to protect their account 135 | * with a Multi-factor Authentication (MFA) tool like a TOTP 136 | * authenticator application. 137 | * 138 | * defaults to false 139 | */ 140 | //enforceMFA: false, 141 | 142 | /* ===================== 143 | * Privacy 144 | * ===================== */ 145 | 146 | /* Depending on where your instance is hosted, you may be required to log IP 147 | * addresses of the users who make a change to a document. This setting allows you 148 | * to do so. You can configure the logging system below in this config file. 149 | * Setting this value to true will include a log for each websocket connection 150 | * including this connection's unique ID, the user public key and the IP. 151 | * NOTE: this option requires a log level of "info" or below. 152 | * 153 | * defaults to false 154 | */ 155 | //logIP: false, 156 | 157 | /* ===================== 158 | * Admin 159 | * ===================== */ 160 | 161 | /* 162 | * CryptPad contains an administration panel. Its access is restricted to specific 163 | * users using the following list. 164 | * To give access to the admin panel to a user account, just add their public signing 165 | * key, which can be found on the settings page for registered users. 166 | * Entries should be strings separated by a comma. 167 | * adminKeys: [ 168 | * "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", 169 | * "[cryptpad-user2@my.awesome.website/jA-9c5iNuG7SyxzGCjwJXVnk5NPfAOO8fQuQ0dC83RE=]", 170 | * ] 171 | * 172 | */ 173 | adminKeys: [ 174 | 175 | ], 176 | 177 | /* ===================== 178 | * STORAGE 179 | * ===================== */ 180 | 181 | /* Pads that are not 'pinned' by any registered user can be set to expire 182 | * after a configurable number of days of inactivity (default 90 days). 183 | * The value can be changed or set to false to remove expiration. 184 | * Expired pads can then be removed using a cron job calling the 185 | * `evict-inactive.js` script with node 186 | * 187 | * defaults to 90 days if nothing is provided 188 | */ 189 | //inactiveTime: 90, // days 190 | 191 | /* CryptPad archives some data instead of deleting it outright. 192 | * This archived data still takes up space and so you'll probably still want to 193 | * remove these files after a brief period. 194 | * 195 | * cryptpad/scripts/evict-archived.js is intended to be run daily 196 | * from a crontab or similar scheduling service. 197 | * 198 | * The intent with this feature is to provide a safety net in case of accidental 199 | * deletion. Set this value to the number of days you'd like to retain 200 | * archived data before it's removed permanently. 201 | * 202 | * defaults to 15 days if nothing is provided 203 | */ 204 | //archiveRetentionTime: 15, 205 | 206 | /* It's possible to configure your instance to remove data 207 | * stored on behalf of inactive accounts. Set 'accountRetentionTime' 208 | * to the number of days an account can remain idle before its 209 | * documents and other account data is removed. 210 | * 211 | * Leave this value commented out to preserve all data stored 212 | * by user accounts regardless of inactivity. 213 | */ 214 | //accountRetentionTime: 365, 215 | 216 | /* Starting with CryptPad 3.23.0, the server automatically runs 217 | * the script responsible for removing inactive data according to 218 | * your configured definition of inactivity. Set this value to `true` 219 | * if you prefer not to remove inactive data, or if you prefer to 220 | * do so manually using `scripts/evict-inactive.js`. 221 | */ 222 | //disableIntegratedEviction: true, 223 | 224 | 225 | /* Max Upload Size (bytes) 226 | * this sets the maximum size of any one file uploaded to the server. 227 | * anything larger than this size will be rejected 228 | * defaults to 20MB if no value is provided 229 | */ 230 | //maxUploadSize: 20 * 1024 * 1024, 231 | 232 | /* Users with premium accounts (those with a plan included in their customLimit) 233 | * can benefit from an increased upload size limit. By default they are restricted to the same 234 | * upload size as any other registered user. 235 | * 236 | */ 237 | //premiumUploadSize: 100 * 1024 * 1024, 238 | 239 | /* ===================== 240 | * DATABASE VOLUMES 241 | * ===================== */ 242 | 243 | /* 244 | * CryptPad stores each document in an individual file on your hard drive. 245 | * Specify a directory where files should be stored. 246 | * It will be created automatically if it does not already exist. 247 | */ 248 | filePath: './datastore/', 249 | 250 | /* CryptPad offers the ability to archive data for a configurable period 251 | * before deleting it, allowing a means of recovering data in the event 252 | * that it was deleted accidentally. 253 | * 254 | * To set the location of this archive directory to a custom value, change 255 | * the path below: 256 | */ 257 | archivePath: './data/archive', 258 | 259 | /* CryptPad allows logged in users to request that particular documents be 260 | * stored by the server indefinitely. This is called 'pinning'. 261 | * Pin requests are stored in a pin-store. The location of this store is 262 | * defined here. 263 | */ 264 | pinPath: './data/pins', 265 | 266 | /* if you would like the list of scheduled tasks to be stored in 267 | a custom location, change the path below: 268 | */ 269 | taskPath: './data/tasks', 270 | 271 | /* if you would like users' authenticated blocks to be stored in 272 | a custom location, change the path below: 273 | */ 274 | blockPath: './block', 275 | 276 | /* CryptPad allows logged in users to upload encrypted files. Files/blobs 277 | * are stored in a 'blob-store'. Set its location here. 278 | */ 279 | blobPath: './blob', 280 | 281 | /* CryptPad stores incomplete blobs in a 'staging' area until they are 282 | * fully uploaded. Set its location here. 283 | */ 284 | blobStagingPath: './data/blobstage', 285 | 286 | decreePath: './data/decrees', 287 | 288 | /* CryptPad supports logging events directly to the disk in a 'logs' directory 289 | * Set its location here, or set it to false (or nothing) if you'd rather not log 290 | */ 291 | logPath: './data/logs', 292 | 293 | /* ===================== 294 | * Debugging 295 | * ===================== */ 296 | 297 | /* CryptPad can log activity to stdout 298 | * This may be useful for debugging 299 | */ 300 | logToStdout: false, 301 | 302 | /* CryptPad can be configured to log more or less 303 | * the various settings are listed below by order of importance 304 | * 305 | * silly, verbose, debug, feedback, info, warn, error 306 | * 307 | * Choose the least important level of logging you wish to see. 308 | * For example, a 'silly' logLevel will display everything, 309 | * while 'info' will display 'info', 'warn', and 'error' logs 310 | * 311 | * This will affect both logging to the console and the disk. 312 | */ 313 | logLevel: 'info', 314 | 315 | /* clients can use the /settings/ app to opt out of usage feedback 316 | * which informs the server of things like how much each app is being 317 | * used, and whether certain clientside features are supported by 318 | * the client's browser. The intent is to provide feedback to the admin 319 | * such that the service can be improved. Enable this with `true` 320 | * and ignore feedback with `false` or by commenting the attribute 321 | * 322 | * You will need to set your logLevel to include 'feedback'. Set this 323 | * to false if you'd like to exclude feedback from your logs. 324 | */ 325 | logFeedback: false, 326 | 327 | /* CryptPad supports verbose logging 328 | * (false by default) 329 | */ 330 | verbose: false, 331 | 332 | /* Surplus information: 333 | * 334 | * 'installMethod' is included in server telemetry to voluntarily 335 | * indicate how many instances are using unofficial installation methods 336 | * such as Docker. 337 | * 338 | */ 339 | installMethod: 'yunohost', 340 | }; 341 | -------------------------------------------------------------------------------- /conf/nginx-sandbox.conf: -------------------------------------------------------------------------------- 1 | # Note this is a mostly a copy of https://github.com/YunoHost/yunohost/blob/dev/conf/nginx/server.tpl.conf 2 | # But with some cleanup of all not necessary things 3 | 4 | server { 5 | listen 80; 6 | listen [::]:80; 7 | server_name sandbox.__DOMAIN__; 8 | 9 | include /etc/nginx/conf.d/acme-challenge.conf.inc; 10 | 11 | location ^~ '/.well-known/ynh-diagnosis/' { 12 | alias /var/www/.well-known/ynh-diagnosis/; 13 | } 14 | 15 | # Note that this != "False" is meant to be failure-safe, in the case the redrect_to_https would happen to contain empty string or whatever value. We absolutely don't want to disable the HTTPS redirect *except* when it's explicitly being asked to be disabled. #} 16 | location / { 17 | return 301 https://$host$request_uri; 18 | } 19 | 20 | include /etc/nginx/conf.d/yunohost_http_errors.conf.inc; 21 | 22 | access_log /var/log/nginx/__DOMAIN__-access.log; 23 | error_log /var/log/nginx/__DOMAIN__-error.log; 24 | } 25 | 26 | server { 27 | listen 443 ssl http2; 28 | listen [::]:443 ssl http2; 29 | server_name sandbox.__DOMAIN__; 30 | 31 | include /etc/nginx/conf.d/security.conf.inc; 32 | 33 | ssl_certificate /etc/yunohost/certs/__DOMAIN__/crt.pem; 34 | ssl_certificate_key /etc/yunohost/certs/__DOMAIN__/key.pem; 35 | 36 | more_set_headers "Strict-Transport-Security : max-age=63072000; includeSubDomains; preload"; 37 | 38 | include /etc/nginx/conf.d/__APP__-shared.conf.inc; 39 | 40 | # We consider that the CA is letsencrypt but yes it could be not allways the case 41 | # This should be improved mybe at some point if this is a problem in some cases 42 | 43 | # OCSP settings 44 | ssl_stapling on; 45 | ssl_stapling_verify on; 46 | ssl_trusted_certificate /etc/yunohost/certs/__DOMAIN__/crt.pem; 47 | resolver 1.1.1.1 9.9.9.9 valid=300s; 48 | resolver_timeout 5s; 49 | 50 | access_log /var/log/nginx/__DOMAIN__-access.log; 51 | error_log /var/log/nginx/__DOMAIN__-error.log; 52 | 53 | location / { 54 | proxy_pass http://localhost:__PORT__; 55 | proxy_set_header X-Real-IP $remote_addr; 56 | proxy_set_header Host $host; 57 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 58 | client_max_body_size 150m; 59 | 60 | proxy_http_version 1.1; 61 | proxy_set_header Upgrade $http_upgrade; 62 | proxy_set_header Connection upgrade; 63 | } 64 | 65 | location ^~ /cryptpad_websocket { 66 | proxy_pass http://localhost:__PORT_SOCKET__; 67 | proxy_set_header X-Real-IP $remote_addr; 68 | proxy_set_header Host $host; 69 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 70 | 71 | proxy_http_version 1.1; 72 | proxy_set_header Upgrade $http_upgrade; 73 | proxy_set_header Connection upgrade; 74 | } 75 | } -------------------------------------------------------------------------------- /conf/nginx-shared.conf: -------------------------------------------------------------------------------- 1 | # Config adapted following the https://__DOMAIN__/checkup/ 2 | 3 | set $styleSrc "'unsafe-inline' 'self' https://__DOMAIN__"; 4 | set $scriptSrc "'self' resource: https://__DOMAIN__"; 5 | set $connectSrc "'self' blob: https://__DOMAIN__ https://__SANDBOXDOMAIN__ wss://__DOMAIN__"; 6 | set $fontSrc "'self' data: https://__DOMAIN__"; 7 | set $imgSrc "'self' data: blob: https://__DOMAIN__"; 8 | set $frameSrc "'self' https://__SANDBOXDOMAIN__ blob:"; 9 | set $mediaSrc "blob:"; 10 | set $childSrc "https://__DOMAIN__"; 11 | set $workerSrc "'self'"; 12 | set $frameAncestors "'self' https://__DOMAIN__"; 13 | set $unsafe 0; 14 | if ($uri ~ ^/(sheet|presentation|doc)/inner.html.*$) { set $unsafe 1; } 15 | if ($uri ~ ^\/common\/onlyoffice\/.*\/.*\.html.*$) { set $unsafe 1; } 16 | if ($host != "__SANDBOXDOMAIN__") { set $unsafe 0; } 17 | if ($uri ~ ^\/unsafeiframe\/inner\.html.*$) { set $unsafe 1; } 18 | if ($unsafe) { 19 | set $scriptSrc "'self' 'unsafe-eval' 'unsafe-inline' resource: https://__DOMAIN__"; 20 | } 21 | 22 | more_set_headers "Content-Security-Policy: default-src 'none'; child-src $childSrc; worker-src $workerSrc; media-src $mediaSrc; style-src $styleSrc; script-src $scriptSrc; connect-src $connectSrc; font-src $fontSrc; img-src $imgSrc; frame-src $frameSrc; frame-ancestors $frameAncestors"; 23 | -------------------------------------------------------------------------------- /conf/nginx.conf: -------------------------------------------------------------------------------- 1 | location / { 2 | proxy_pass http://127.0.0.1:__PORT__; 3 | proxy_set_header X-Real-IP $remote_addr; 4 | proxy_set_header Host $host; 5 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 6 | client_max_body_size 150m; 7 | 8 | proxy_http_version 1.1; 9 | proxy_set_header Upgrade $http_upgrade; 10 | proxy_set_header Connection upgrade; 11 | 12 | include /etc/nginx/conf.d/__APP__-shared.conf.inc; 13 | } 14 | 15 | location ^~ /cryptpad_websocket { 16 | proxy_pass http://127.0.0.1:__PORT_SOCKET__; 17 | proxy_set_header X-Real-IP $remote_addr; 18 | proxy_set_header Host $host; 19 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 20 | 21 | proxy_http_version 1.1; 22 | proxy_set_header Upgrade $http_upgrade; 23 | proxy_set_header Connection upgrade; 24 | 25 | include /etc/nginx/conf.d/__APP__-shared.conf.inc; 26 | } -------------------------------------------------------------------------------- /conf/systemd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=CryptPad: Zero Knowledge realtime collaborative editor. 3 | After=syslog.target network.target 4 | 5 | [Service] 6 | Type=simple 7 | User=__APP__ 8 | Group=__APP__ 9 | WorkingDirectory=__INSTALL_DIR__ 10 | Environment=PATH=PATH=__PATH_WITH_NODEJS__ 11 | Environment='PWD="__INSTALL_DIR__"' 12 | ExecStart=__NODEJS_DIR__/npm start 13 | Restart=always 14 | LimitNOFILE=1000000 15 | 16 | # Sandboxing options to harden security 17 | # Depending on specificities of your service/app, you may need to tweak these 18 | # .. but this should be a good baseline 19 | # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html 20 | NoNewPrivileges=yes 21 | PrivateTmp=yes 22 | PrivateDevices=yes 23 | RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 24 | RestrictNamespaces=yes 25 | RestrictRealtime=yes 26 | DevicePolicy=closed 27 | ProtectSystem=full 28 | ProtectControlGroups=yes 29 | ProtectKernelModules=yes 30 | ProtectKernelTunables=yes 31 | LockPersonality=yes 32 | SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap 33 | 34 | # Denying access to capabilities that should not be relevant for webapps 35 | # Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html 36 | CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD 37 | CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE 38 | CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT 39 | CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK 40 | CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM 41 | CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG 42 | CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE 43 | CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW 44 | CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 45 | 46 | [Install] 47 | WantedBy=multi-user.target 48 | -------------------------------------------------------------------------------- /doc/ADMIN.md: -------------------------------------------------------------------------------- 1 | We have added the mandatory sandbox domain for you but you still need to configure your DNS and generate Let's Encrypt Certificates for it !! 2 | 3 | Once CryptPad is installed, create an account via the Register button on the home page. To make this account an instance administrator: 4 | 5 | 1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key 6 | 2. Paste this key in `__INSTALL_DIR__/config/config.js` in the following array (uncomment and replace the placeholder): 7 | ``` 8 | adminKeys: [ 9 | "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", 10 | ], 11 | ``` 12 | 13 | 3. Restart CryptPad service (In YunoHost webadmin -> Services -> cryptpad -> Restart) 14 | -------------------------------------------------------------------------------- /doc/ADMIN_fr.md: -------------------------------------------------------------------------------- 1 | ## Configuration 2 | 3 | Nous avons ajouté le domaine obligatoire sandbox pour vous mais vous devez encore configurer votre DNS et générer les certificats pour celui-ci. 4 | 5 | Une fois CryptPad installé, créez un compte via le bouton S'inscrire sur la page d'accueil. Pour faire de ce compte un administrateur d'instance : 6 | 7 | 1. Copiez la clé publique trouvée dans le menu utilisateur (avatar en haut à droite) > Paramètres > Compte > Clé de signature publique 8 | 2. Collez cette clé dans `__INSTALL_DIR__/config/config.js` dans le tableau suivant (décommentez et remplacez l'espace réservé) : 9 | ``` 10 | adminKeys: [ 11 | "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", 12 | ], 13 | ``` 14 | 15 | 3. Redémarrer le service CryptPad (Dans webadmin YunoHost -> Services -> cryptpad -> Redémarrer) 16 | -------------------------------------------------------------------------------- /doc/DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. -------------------------------------------------------------------------------- /doc/DESCRIPTION_fr.md: -------------------------------------------------------------------------------- 1 | CryptPad est une suite de collaboration chiffrée de bout en bout et open source. Il est conçu pour permettre la collaboration, en synchronisant les modifications apportées aux documents en temps réel. Étant donné que toutes les données sont chiffrées, le service et ses administrateurs n'ont aucun moyen de voir le contenu modifié et stocké. -------------------------------------------------------------------------------- /doc/POST_INSTALL.md: -------------------------------------------------------------------------------- 1 | We have added a sandbox domain: __SANDBOXDOMAIN__ for you but you still need to configure your DNS and regenerate the Let's Encrypt Certificates for the main domain. 2 | You will need also to restart CryptPad service after this is done. 3 | 4 | Then you can please open CryptPad domain: https://__DOMAIN__ 5 | 6 | Once CryptPad is installed, create an account via the Sign Up button on the home page which will take you to the Register page. 7 | To make this account an instance administrator: 8 | 9 | 1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key 10 | 2. Paste this key in `__INSTALL_DIR__/config/config.js` in the following array (uncomment and replace the placeholder): 11 | 12 | ``` 13 | adminKeys: [ 14 | "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", 15 | ], 16 | ``` 17 | -------------------------------------------------------------------------------- /doc/POST_INSTALL_fr.md: -------------------------------------------------------------------------------- 1 | Nous avons ajouté un domaine sandbox : __SANDBOXDOMAIN__ pour vous, mais vous devez encore configurer votre DNS et régénérer les certificats Let's Encrypt pour le domaine principal. 2 | Vous devrez également redémarrer le service CryptPad une fois cette opération terminée. 3 | 4 | Vous pouvez ensuite ouvrir le domaine CryptPad : https://__DOMAIN__ 5 | 6 | Une fois CryptPad installé, créez un compte via le bouton Inscription sur la page d'accueil qui vous mènera à la page d'inscription. 7 | Pour faire de ce compte un administrateur d'instance : 8 | 9 | 1. Copiez la clé publique trouvée dans le menu utilisateur (avatar en haut à droite) > Paramètres > Compte > Clé de signature publique 10 | 2. Collez cette clé dans `__INSTALL_DIR__/config/config.js` dans le tableau suivant (décommentez et remplacez l'espace réservé) : 11 | 12 | ``` 13 | adminKeys : [ 14 | "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", 15 | ], 16 | ``` 17 | -------------------------------------------------------------------------------- /doc/POST_UPGRADE.d/2024.9.1~ynh1.md: -------------------------------------------------------------------------------- 1 | You will need to do these 2 operations: 2 | - Update your DNS config according the suggested config for the domain "__DOMAIN__". In most of case it will consist of adding a `CNAME` for `sandbox.__DOMAIN__` to `__DOMAIN__`. You can see the suggested configuration with this following command: 3 | ``` 4 | yunohost domain dns suggest __DOMAIN__ 5 | ``` 6 | Please, be sure the CNAME is correctly added on your dns zone and wait for the DNS propagation 7 | 8 | - After that you will need to (force) renew your (let's encrypt) certificate. This is needed to add as "alternative domain" the domain `sandbox.__DOMAIN__` in your certificate. To do this you can do it from the webadmin in "Domains" > "__DOMAIN__" > "Certificate" > "Renew Let's Encrypt certificate" or from this following command: 9 | ``` 10 | yunohost domain cert renew __DOMAIN__ --force 11 | ``` 12 | -------------------------------------------------------------------------------- /doc/POST_UPGRADE.md: -------------------------------------------------------------------------------- 1 | We have added a sandbox domain for you but you still need to configure your DNS and generate Let's Encrypt Certificates for it !! 2 | If not already done, then you can please open CryptPad domain: https://__DOMAIN__ 3 | 4 | Create an account via the Register button on the home page. To make this account an instance administrator: 5 | 1. Copy the public key found in User Menu (avatar at the top right) > Settings > Account > Public Signing Key 6 | 2. Paste this key in __INSTALL_DIR__/config/config.js in the following array (uncomment and replace the placeholder): 7 | adminKeys: [ 8 | "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", 9 | ], 10 | If you are facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/cryptpad_ynh" 11 | -------------------------------------------------------------------------------- /doc/POST_UPGRADE_fr.md: -------------------------------------------------------------------------------- 1 | Nous avons ajouté un domaine sandbox pour vous, mais vous devez encore configurer votre DNS et générer des certificats Let's Encrypt pour celui-ci !! 2 | Si ce n'est pas déjà fait, vous pouvez ouvrir le domaine CryptPad : https://__DOMAIN__ 3 | 4 | Créez un compte via le bouton S'inscrire sur la page d'accueil. Pour faire de ce compte un administrateur d'instance : 5 | 1. Copiez la clé publique trouvée dans le menu utilisateur (avatar en haut à droite) > Paramètres > Compte > Clé de signature publique 6 | 2. Collez cette clé dans __INSTALL_DIR__/config/config.js dans le tableau suivant (décommentez et remplacez l'espace réservé) : 7 | adminKeys : [ 8 | "[cryptpad-user1@my.awesome.website/YZgXQxKR0Rcb6r6CmxHPdAGLVludrAF2lEnkbx1vVOo=]", 9 | ], 10 | Si vous rencontrez un problème ou souhaitez améliorer cette application, veuillez ouvrir un nouveau problème dans ce projet : https://github.com/YunoHost-Apps/cryptpad_ynh" -------------------------------------------------------------------------------- /doc/screenshots/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/cryptpad_ynh/5fc199e4fda686c401c6b441130b495693f64926/doc/screenshots/screenshot.png -------------------------------------------------------------------------------- /hooks/cert_alternate_names: -------------------------------------------------------------------------------- 1 | # This script is expected to be called xx-$app 2 | app=$(basename $0 | cut -d- -f2) 3 | app_domain=$(yunohost app setting $app domain) 4 | sandboxdomain=$(yunohost app setting $app sandboxdomain) 5 | 6 | if [[ "$domain" != "$app_domain" ]] 7 | then 8 | exit 0 9 | fi 10 | 11 | cat << EOF >> $YNH_STDRETURN 12 | - $sandboxdomain 13 | EOF 14 | -------------------------------------------------------------------------------- /hooks/custom_dns_rules: -------------------------------------------------------------------------------- 1 | # This script is expected to be called xx-$app 2 | app=$(basename $0 | cut -d- -f2) 3 | domain=$(yunohost app setting $app domain) 4 | sandboxdomain=$(yunohost app setting $app sandboxdomain) 5 | 6 | if [[ "$domain" != "$base_domain" ]] 7 | then 8 | exit 0 9 | fi 10 | 11 | cat << EOF >> $YNH_STDRETURN 12 | - name: "$sandboxdomain" 13 | ttl: 3600 14 | type: "CNAME" 15 | value: "$domain." 16 | EOF -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | packaging_format = 2 2 | 3 | id = "cryptpad" 4 | name = "CryptPad" 5 | description.en = "Zero Knowledge realtime collaborative office suite" 6 | description.fr = "Suite bureautique chiffrée pour la collaboration en temps réel" 7 | 8 | version = "2025.3.0~ynh1" 9 | 10 | maintainers = ["ddataa"] 11 | 12 | [upstream] 13 | license = "AGPL-3.0-only" 14 | website = "https://cryptpad.fr/" 15 | demo = "https://cryptpad.fr/" 16 | admindoc = "https://docs.cryptpad.fr/en/" 17 | code = "https://github.com/cryptpad/cryptpad" 18 | cpe = "cpe:2.3:a:xwiki:cryptpad" 19 | fund = "https://opencollective.com/cryptpad/contribute?language=fr" 20 | 21 | [integration] 22 | yunohost = ">= 12.0.9" 23 | helpers_version = "2.1" 24 | architectures = "all" 25 | multi_instance = true 26 | 27 | ldap = false 28 | 29 | sso = false 30 | 31 | disk = "50M" 32 | ram.build = "350M" 33 | ram.runtime = "50M" 34 | 35 | [install] 36 | [install.domain] 37 | help.en = "CryptPad needs to be installed in a dedicated domain or sub-domain." 38 | help.fr = "CryptPad doit être installé dans un domaine ou sous-domaine dédié." 39 | type = "domain" 40 | 41 | [install.init_main_permission] 42 | help.en = "If 'Visitors' enabled, CryptPad will be accessible by people who do not have an account. This can be changed later via the webadmin." 43 | help.fr = "Si 'Visiteurs' est cochée, CryptPad sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." 44 | type = "group" 45 | default = "visitors" 46 | 47 | [resources] 48 | 49 | [resources.sources.main] 50 | url = "https://github.com/xwiki-labs/cryptpad/archive/refs/tags/2025.3.0.tar.gz" 51 | sha256 = "ec2916ffd38bdf1a99d88a4382f70e9144f489e06ca674e2c060c711da5a3e09" 52 | autoupdate.strategy = "latest_github_tag" 53 | 54 | [resources.ports] 55 | main.default = 3000 56 | socket.default = 3003 57 | 58 | [resources.system_user] 59 | 60 | [resources.install_dir] 61 | 62 | [resources.permissions] 63 | main.url = "/" 64 | 65 | [resources.apt] 66 | packages = ["less"] 67 | -------------------------------------------------------------------------------- /scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # COMMON VARIABLES AND CUSTOM HELPERS 5 | #================================================= 6 | 7 | nodejs_version="22" 8 | -------------------------------------------------------------------------------- /scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source ../settings/scripts/_common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | ynh_print_info "Declaring files to be backed up..." 7 | 8 | #================================================= 9 | # BACKUP THE APP MAIN DIR 10 | #================================================= 11 | 12 | ynh_backup "$install_dir" 13 | 14 | #================================================= 15 | # SYSTEM CONFIGURATION 16 | #================================================= 17 | 18 | ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" 19 | ynh_backup "/etc/nginx/conf.d/sandbox."$domain".conf" 20 | ynh_backup "/etc/nginx/conf.d/"$app"-shared.conf.inc" 21 | 22 | ynh_backup "/etc/systemd/system/$app.service" 23 | 24 | #================================================= 25 | # END OF SCRIPT 26 | #================================================= 27 | 28 | ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." 29 | -------------------------------------------------------------------------------- /scripts/change_url: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # STOP SYSTEMD SERVICE 8 | #================================================= 9 | ynh_script_progression "Stopping $app's systemd service..." 10 | 11 | ynh_systemctl --service=$app --action="stop" --log_path=systemd 12 | 13 | #================================================= 14 | # MODIFY URL IN NGINX CONF 15 | #================================================= 16 | ynh_script_progression "Updating NGINX web server configuration..." 17 | 18 | ynh_config_change_url_nginx 19 | 20 | #================================================= 21 | # START SYSTEMD SERVICE 22 | #================================================= 23 | ynh_script_progression "Starting $app's systemd service..." 24 | 25 | ynh_systemctl --service=$app --action="start" --log_path=systemd 26 | 27 | #================================================= 28 | # END OF SCRIPT 29 | #================================================= 30 | 31 | ynh_script_progression "Change of URL completed for $app" 32 | -------------------------------------------------------------------------------- /scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # INITIALIZE AND STORE SETTINGS 8 | #================================================= 9 | 10 | sandboxdomain=sandbox.$domain 11 | ynh_app_setting_set --key=sandboxdomain --value="$sandboxdomain" 12 | 13 | #================================================= 14 | # INSTALL DEPENDENCIES 15 | #================================================= 16 | ynh_script_progression "Installing dependencies..." 17 | 18 | ynh_nodejs_install 19 | 20 | #================================================= 21 | # DOWNLOAD, CHECK AND UNPACK SOURCE 22 | #================================================= 23 | ynh_script_progression "Setting up source files..." 24 | 25 | ynh_setup_source --dest_dir="$install_dir" 26 | 27 | #================================================= 28 | # SYSTEM CONFIGURATION 29 | #================================================= 30 | ynh_script_progression "Adding system configurations related to $app..." 31 | 32 | ynh_config_add --template=nginx-sandbox.conf --destination=/etc/nginx/conf.d/sandbox."$domain".conf 33 | ynh_config_add --template=nginx-shared.conf --destination=/etc/nginx/conf.d/"$app"-shared.conf.inc 34 | 35 | chown www-data:www-data /etc/nginx/conf.d/sandbox."$domain".conf 36 | chown www-data:www-data /etc/nginx/conf.d/"$app"-shared.conf.inc 37 | 38 | ynh_config_add_nginx 39 | 40 | ynh_config_add_systemd 41 | 42 | yunohost service add $app --description="Zero Knowledge realtime collaborative editor" --log="/var/log/$app/$app.log" 43 | 44 | #================================================= 45 | # ADD A CONFIGURATION 46 | #================================================= 47 | ynh_script_progression "Adding $app's configuration..." 48 | 49 | ynh_config_add --template="config.js" --destination="$install_dir/config/config.js" 50 | 51 | chmod 600 "$install_dir/config/config.js" 52 | 53 | #================================================= 54 | # INSTALL CRYPTPAD 55 | #================================================= 56 | ynh_script_progression "Building $app... (this will take some time and resources!)" 57 | 58 | pushd "$install_dir" 59 | ynh_hide_warnings ynh_exec_as_app npm ci 60 | ynh_hide_warnings ynh_exec_as_app npm run install:components 61 | ynh_hide_warnings ynh_exec_as_app npm run build 62 | ynh_hide_warnings bash install-onlyoffice.sh --accept-license 63 | popd 64 | 65 | #================================================= 66 | # START SYSTEMD SERVICE 67 | #================================================= 68 | ynh_script_progression "Starting $app's systemd service..." 69 | 70 | ynh_systemctl --service=$app --action="start" --log_path="systemd" 71 | 72 | #================================================= 73 | # APPLY FOLDER RIGHTS 74 | #================================================= 75 | 76 | chgrp -R www-data $install_dir 77 | 78 | #================================================= 79 | # END OF SCRIPT 80 | #================================================= 81 | 82 | ynh_script_progression "Installation of $app completed" 83 | -------------------------------------------------------------------------------- /scripts/remove: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # REMOVE SYSTEM CONFIGURATIONS 8 | #================================================= 9 | ynh_script_progression "Removing system configurations related to $app..." 10 | 11 | if ynh_hide_warnings yunohost service status $app >/dev/null; then 12 | yunohost service remove $app 13 | fi 14 | 15 | ynh_config_remove_systemd 16 | 17 | ynh_safe_rm /etc/nginx/conf.d/sandbox."$domain".conf 18 | ynh_safe_rm /etc/nginx/conf.d/"$app"-shared.conf.inc 19 | ynh_config_remove_nginx 20 | 21 | ynh_nodejs_remove 22 | 23 | #================================================= 24 | # REMOVE SANDBOX DOMAIN 25 | #================================================= 26 | 27 | # We don't test that in CI 28 | if ! ynh_in_ci_tests; then 29 | 30 | # if the main domain for the app is a root domain, we create a correct sandbox subdomain 31 | if [[ $domain == *"."* ]]; then 32 | sandboxdomain=sandbox.$domain 33 | fi 34 | # if the main domain for the app is already a sub-domain, we create a correct sandbox domain 35 | if [[ $domain == *"."*"."* ]]; then 36 | sandboxdomain=sandbox-$domain 37 | fi 38 | # if the main domain for the app is a .local root domain, we create a correct sandbox subdomain 39 | if [[ $domain == *".local" ]]; then 40 | sandboxdomain=sandbox-$domain 41 | fi 42 | 43 | ynh_script_progression "Removing sandbox domain: $sandboxdomain" 44 | 45 | if yunohost domain list | grep -q $sandboxdomain 46 | then #if domain exist we remove it 47 | yunohost domain remove $sandboxdomain 48 | # we clean the nginx configuration we added 49 | ynh_safe_rm "/etc/nginx/conf.d/$sandboxdomain.d/" 50 | fi 51 | fi 52 | 53 | #================================================= 54 | # END OF SCRIPT 55 | #================================================= 56 | 57 | ynh_script_progression "Removal of $app completed" 58 | -------------------------------------------------------------------------------- /scripts/restore: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source ../settings/scripts/_common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # RESTORE THE APP MAIN DIR 8 | #================================================= 9 | ynh_script_progression "Restoring the app main directory..." 10 | 11 | ynh_restore "$install_dir" 12 | 13 | #================================================= 14 | # APPLY FOLDER GROUP RIGHTS FOR WWW-DATA 15 | #================================================= 16 | 17 | chgrp -R www-data $install_dir 18 | 19 | #================================================= 20 | # REINSTALL DEPENDENCIES 21 | #================================================= 22 | ynh_script_progression "Reinstalling dependencies..." 23 | 24 | ynh_nodejs_install 25 | 26 | #================================================= 27 | # RESTORE SYSTEM CONFIGURATIONS 28 | #================================================= 29 | ynh_script_progression "Restoring system configurations related to $app..." 30 | 31 | ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf" 32 | ynh_restore /etc/nginx/conf.d/sandbox."$domain".conf 33 | ynh_restore /etc/nginx/conf.d/"$app"-shared.conf.inc 34 | chown www-data:www-data /etc/nginx/conf.d/sandbox."$domain".conf 35 | chown www-data:www-data /etc/nginx/conf.d/"$app"-shared.conf.inc 36 | 37 | ynh_restore "/etc/systemd/system/$app.service" 38 | systemctl enable $app.service --quiet 39 | 40 | yunohost service add $app --description="Zero Knowledge realtime collaborative editor" --log="/var/log/$app/$app.log" 41 | 42 | #================================================= 43 | # RELOAD NGINX AND PHP-FPM OR THE APP SERVICE 44 | #================================================= 45 | ynh_script_progression "Reloading NGINX web server and $app's service..." 46 | 47 | ynh_systemctl --service=$app --action="start" --log_path=systemd 48 | 49 | ynh_systemctl --service=nginx --action=reload 50 | 51 | #================================================= 52 | # END OF SCRIPT 53 | #================================================= 54 | 55 | ynh_script_progression "Restoration completed for $app" 56 | -------------------------------------------------------------------------------- /scripts/upgrade: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # MANAGING MIGRATIONS 8 | #================================================= 9 | ynh_script_progression "Managing migrations..." 10 | 11 | # remove the legacy way to manage sandbox domain 12 | if yunohost domain list --output-as plain | grep -q "sandbox\.${domain}"; then 13 | yunohost domain remove "sandbox.$domain" 14 | ynh_print_warn "Since some changes was done on the sandbox domain, you will need to regenerate the certificate for $domain and update your DNS config accordingly." 15 | fi 16 | 17 | if yunohost domain list --output-as plain | grep -q "sandbox-${domain}"; then 18 | yunohost domain remove "sandbox-$domain" 19 | ynh_print_warn "Since some changes was done on the sandbox domain, you will need to regenerate the certificate for $domain and update your DNS config accordingly." 20 | fi 21 | 22 | sandboxdomain=sandbox.$domain 23 | ynh_app_setting_set --key=sandboxdomain --value="$sandboxdomain" 24 | 25 | #================================================= 26 | # UPGRADE DEPENDENCIES 27 | #================================================= 28 | ynh_script_progression "Upgrading dependencies..." 29 | 30 | ynh_nodejs_install 31 | 32 | #================================================= 33 | # STOP SYSTEMD SERVICE 34 | #================================================= 35 | ynh_script_progression "Stopping $app's systemd service..." 36 | 37 | ynh_systemctl --service=$app --action="stop" 38 | 39 | #================================================= 40 | # DOWNLOAD, CHECK AND UNPACK SOURCE 41 | #================================================= 42 | ynh_script_progression "Upgrading source files..." 43 | 44 | ynh_setup_source --dest_dir="$install_dir" --keep="customize" 45 | 46 | #================================================= 47 | # APPLY FOLDER GROUP RIGHTS FOR WWW-DATA 48 | #================================================= 49 | 50 | chgrp -R www-data $install_dir 51 | 52 | #================================================= 53 | # NGINX CONFIGURATION 54 | #================================================= 55 | ynh_script_progression "Upgrading NGINX web server configuration..." 56 | 57 | ynh_config_add --template=nginx-sandbox.conf --destination=/etc/nginx/conf.d/sandbox."$domain".conf 58 | ynh_config_add --template=nginx-shared.conf --destination=/etc/nginx/conf.d/"$app"-shared.conf.inc 59 | 60 | chown www-data:www-data /etc/nginx/conf.d/sandbox."$domain".conf 61 | chown www-data:www-data /etc/nginx/conf.d/"$app"-shared.conf.inc 62 | 63 | ynh_config_add_nginx 64 | 65 | ynh_config_add_systemd 66 | 67 | yunohost service add $app --description="Zero Knowledge realtime collaborative editor" --log="/var/log/$app/$app.log" 68 | 69 | #================================================= 70 | # INSTALL CRYPTPAD 71 | #================================================= 72 | ynh_script_progression "Building $app... (this will take some time and resources!)" 73 | 74 | pushd "$install_dir" 75 | ynh_hide_warnings ynh_exec_as_app npm ci 76 | ynh_hide_warnings ynh_exec_as_app npm run install:components 77 | ynh_hide_warnings ynh_exec_as_app npm run build 78 | ynh_hide_warnings bash install-onlyoffice.sh --accept-license 79 | popd 80 | 81 | #================================================= 82 | # ADD UPGRADED CONFIG WITH SANDBOX 83 | #================================================= 84 | ynh_script_progression "Updating configuration..." 85 | 86 | ynh_config_add --template="config.js" --destination="$install_dir/config/config.js" 87 | 88 | chmod 600 "$install_dir/config/config.js" 89 | 90 | #================================================= 91 | # START SYSTEMD SERVICE 92 | #================================================= 93 | ynh_script_progression "Starting $app's systemd service..." 94 | 95 | ynh_systemctl --service=$app --action="start" --log_path=systemd 96 | 97 | #================================================= 98 | # END OF SCRIPT 99 | #================================================= 100 | 101 | ynh_script_progression "Upgrade of $app completed" 102 | -------------------------------------------------------------------------------- /tests.toml: -------------------------------------------------------------------------------- 1 | test_format = 1.0 2 | 3 | [default] 4 | 5 | # ------------ 6 | # Tests to run 7 | # ------------ 8 | 9 | exclude = ["install.subdir"] 10 | 11 | args.admin = "john" 12 | 13 | # ------------------------------- 14 | # Commits to test upgrade from 15 | # ------------------------------- 16 | 17 | #test_upgrade_from.2a54cd03.name = "Upgrade from 4.10.0" 18 | 19 | test_upgrade_from.1e360398.name = "Upgrade from 4.12.0" 20 | 21 | test_upgrade_from.4075742998b77f2b5d6251ee70b1e6336acb171e.name = "Upgrade from 5.3.0~ynh2" --------------------------------------------------------------------------------