├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── ALL_README.md ├── LICENSE ├── README.md ├── README_es.md ├── README_eu.md ├── README_fr.md ├── README_gl.md ├── README_id.md ├── README_it.md ├── README_nl.md ├── README_pl.md ├── README_ru.md ├── README_zh_Hans.md ├── conf ├── app.ini ├── ldap.conf ├── nginx.conf └── systemd.service ├── doc ├── ADMIN.md ├── DESCRIPTION.md ├── DESCRIPTION_fr.md └── screenshots │ └── screenshot.png ├── 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 | -------------------------------------------------------------------------------- /ALL_README.md: -------------------------------------------------------------------------------- 1 | # All available README files by language 2 | 3 | - [Read the README in English](README.md) 4 | - [Lea el README en español](README_es.md) 5 | - [Irakurri README euskaraz](README_eu.md) 6 | - [Lire le README en français](README_fr.md) 7 | - [Le o README en galego](README_gl.md) 8 | - [Baca README dalam bahasa bahasa Indonesia](README_id.md) 9 | - [Lees de README in het Nederlands](README_nl.md) 10 | - [Przeczytaj README w języku polski](README_pl.md) 11 | - [Прочитать README на русский](README_ru.md) 12 | - [阅读中文（简体）的 README](README_zh_Hans.md) 13 | -------------------------------------------------------------------------------- /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 | # Gogs for YunoHost 7 | 8 | [![Integration level](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Working status](https://apps.yunohost.org/badge/state/gogs) 10 | ![Maintenance status](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Install Gogs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Read this README in other languages.](./ALL_README.md)* 15 | 16 | > *This package allows you to install Gogs 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 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Shipped version:** 0.13.2~ynh1 36 | 37 | **Demo:** 38 | 39 | ## Screenshots 40 | 41 | ![Screenshot of Gogs](./doc/screenshots/screenshot.png) 42 | 43 | ## Documentation and resources 44 | 45 | - Official app website: 46 | - Official admin documentation: 47 | - Upstream app code repository: 48 | - YunoHost Store: 49 | - Report a bug: 50 | 51 | ## Developer info 52 | 53 | Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | To try the `testing` branch, please proceed like that: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | or 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **More info regarding app packaging:** 64 | -------------------------------------------------------------------------------- /README_es.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs para Yunohost 7 | 8 | [![Nivel de integración](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Estado funcional](https://apps.yunohost.org/badge/state/gogs) 10 | ![Estado En Mantención](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Instalar Gogs con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Leer este README en otros idiomas.](./ALL_README.md)* 15 | 16 | > *Este paquete le permite instalarGogs 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 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Versión actual:** 0.13.2~ynh1 36 | 37 | **Demo:** 38 | 39 | ## Capturas 40 | 41 | ![Captura de Gogs](./doc/screenshots/screenshot.png) 42 | 43 | ## Documentaciones y recursos 44 | 45 | - Sitio web oficial: 46 | - Documentación administrador oficial: 47 | - Repositorio del código fuente oficial de la aplicación : 48 | - Catálogo YunoHost: 49 | - Reportar un error: 50 | 51 | ## Información para desarrolladores 52 | 53 | Por favor enviar sus correcciones a la [rama `testing`](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | Para probar la rama `testing`, sigue asÍ: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | o 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **Mas informaciones sobre el empaquetado de aplicaciones:** 64 | -------------------------------------------------------------------------------- /README_eu.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs YunoHost-erako 7 | 8 | [![Integrazio maila](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Funtzionamendu egoera](https://apps.yunohost.org/badge/state/gogs) 10 | ![Mantentze egoera](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Instalatu Gogs YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* 15 | 16 | > *Pakete honek Gogs 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 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Paketatutako bertsioa:** 0.13.2~ynh1 36 | 37 | **Demoa:** 38 | 39 | ## Pantaila-argazkiak 40 | 41 | ![Gogs(r)en pantaila-argazkia](./doc/screenshots/screenshot.png) 42 | 43 | ## Dokumentazioa eta baliabideak 44 | 45 | - Aplikazioaren webgune ofiziala: 46 | - Administratzaileen dokumentazio ofiziala: 47 | - Jatorrizko aplikazioaren kode-gordailua: 48 | - YunoHost Denda: 49 | - Eman errore baten berri: 50 | 51 | ## Garatzaileentzako informazioa 52 | 53 | Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | `testing` abarra probatzeko, ondorengoa egin: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | edo 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **Informazio gehiago aplikazioaren paketatzeari buruz:** 64 | -------------------------------------------------------------------------------- /README_fr.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs pour YunoHost 7 | 8 | [![Niveau d’intégration](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Statut du fonctionnement](https://apps.yunohost.org/badge/state/gogs) 10 | ![Statut de maintenance](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Installer Gogs avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Lire le README dans d'autres langues.](./ALL_README.md)* 15 | 16 | > *Ce package vous permet d’installer Gogs 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 | Gogs (Go Git Service) est une forge multiplateforme basée sur git écrite en Go. Sa particularité est d’être léger et pouvant fonctionner sur carte ARM, ce qui fait qu’il est adapté à l’auto-hébergement. Gogs a une interface web similaire à celle de GitHub. 22 | 23 | 24 | **Version incluse :** 0.13.2~ynh1 25 | 26 | **Démo :** 27 | 28 | ## Captures d’écran 29 | 30 | ![Capture d’écran de Gogs](./doc/screenshots/screenshot.png) 31 | 32 | ## Documentations et ressources 33 | 34 | - Site officiel de l’app : 35 | - Documentation officielle de l’admin : 36 | - Dépôt de code officiel de l’app : 37 | - YunoHost Store : 38 | - Signaler un bug : 39 | 40 | ## Informations pour les développeurs 41 | 42 | Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 43 | 44 | Pour essayer la branche `testing`, procédez comme suit : 45 | 46 | ```bash 47 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 48 | ou 49 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 50 | ``` 51 | 52 | **Plus d’infos sur le packaging d’applications :** 53 | -------------------------------------------------------------------------------- /README_gl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs para YunoHost 7 | 8 | [![Nivel de integración](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Estado de funcionamento](https://apps.yunohost.org/badge/state/gogs) 10 | ![Estado de mantemento](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Instalar Gogs con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Le este README en outros idiomas.](./ALL_README.md)* 15 | 16 | > *Este paquete permíteche instalar Gogs 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 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Versión proporcionada:** 0.13.2~ynh1 36 | 37 | **Demo:** 38 | 39 | ## Capturas de pantalla 40 | 41 | ![Captura de pantalla de Gogs](./doc/screenshots/screenshot.png) 42 | 43 | ## Documentación e recursos 44 | 45 | - Web oficial da app: 46 | - Documentación oficial para admin: 47 | - Repositorio de orixe do código: 48 | - Tenda YunoHost: 49 | - Informar dun problema: 50 | 51 | ## Info de desenvolvemento 52 | 53 | Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | Para probar a rama `testing`, procede deste xeito: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | ou 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **Máis info sobre o empaquetado da app:** 64 | -------------------------------------------------------------------------------- /README_id.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs untuk YunoHost 7 | 8 | [![Tingkat integrasi](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Status kerja](https://apps.yunohost.org/badge/state/gogs) 10 | ![Status pemeliharaan](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Pasang Gogs dengan YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Baca README ini dengan bahasa yang lain.](./ALL_README.md)* 15 | 16 | > *Paket ini memperbolehkan Anda untuk memasang Gogs 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 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Versi terkirim:** 0.13.2~ynh1 36 | 37 | **Demo:** 38 | 39 | ## Tangkapan Layar 40 | 41 | ![Tangkapan Layar pada Gogs](./doc/screenshots/screenshot.png) 42 | 43 | ## Dokumentasi dan sumber daya 44 | 45 | - Website aplikasi resmi: 46 | - Dokumentasi admin resmi: 47 | - Depot kode aplikasi hulu: 48 | - Gudang YunoHost: 49 | - Laporkan bug: 50 | 51 | ## Info developer 52 | 53 | Silakan kirim pull request ke [`testing` branch](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | Untuk mencoba branch `testing`, silakan dilanjutkan seperti: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | atau 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **Info lebih lanjut mengenai pemaketan aplikasi:** 64 | -------------------------------------------------------------------------------- /README_it.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs per YunoHost 7 | 8 | [![Livello di integrazione](https://dash.yunohost.org/integration/gogs.svg)](https://dash.yunohost.org/appci/app/gogs) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/gogs.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/gogs.maintain.svg) 9 | 10 | [![Installa Gogs con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 11 | 12 | *[Leggi questo README in altre lingue.](./ALL_README.md)* 13 | 14 | > *Questo pacchetto ti permette di installare Gogs su un server YunoHost in modo semplice e veloce.* 15 | > *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* 16 | 17 | ## Panoramica 18 | 19 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 20 | 21 | ### Features 22 | 23 | - User dashboard, user profile and activity timeline. 24 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 25 | - Repository Git hooks, deploy keys and Git LFS. 26 | - Repository issues, pull requests, wiki, protected branches and collaboration. 27 | - Migrate and mirror repositories with wiki from other code hosts. 28 | - Web editor for quick editing repository files and wiki. 29 | - Jupyter Notebook and PDF rendering. 30 | - Authentication via SMTP, LDAP. 31 | 32 | 33 | **Versione pubblicata:** 0.13.0~ynh3 34 | 35 | **Prova:** 36 | 37 | ## Screenshot 38 | 39 | ![Screenshot di Gogs](./doc/screenshots/screenshot.png) 40 | 41 | ## Documentazione e risorse 42 | 43 | - Sito web ufficiale dell’app: 44 | - Documentazione ufficiale per gli amministratori: 45 | - Repository upstream del codice dell’app: 46 | - Store di YunoHost: 47 | - Segnala un problema: 48 | 49 | ## Informazioni per sviluppatori 50 | 51 | Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 52 | 53 | Per provare la branch di `testing`, si prega di procedere in questo modo: 54 | 55 | ```bash 56 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 57 | o 58 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | ``` 60 | 61 | **Maggiori informazioni riguardo il pacchetto di quest’app:** 62 | -------------------------------------------------------------------------------- /README_nl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs voor Yunohost 7 | 8 | [![Integratieniveau](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Mate van functioneren](https://apps.yunohost.org/badge/state/gogs) 10 | ![Onderhoudsstatus](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Gogs met Yunohost installeren](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Deze README in een andere taal lezen.](./ALL_README.md)* 15 | 16 | > *Met dit pakket kun je Gogs 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 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Geleverde versie:** 0.13.2~ynh1 36 | 37 | **Demo:** 38 | 39 | ## Schermafdrukken 40 | 41 | ![Schermafdrukken van Gogs](./doc/screenshots/screenshot.png) 42 | 43 | ## Documentatie en bronnen 44 | 45 | - Officiele website van de app: 46 | - Officiele beheerdersdocumentatie: 47 | - Upstream app codedepot: 48 | - YunoHost-store: 49 | - Meld een bug: 50 | 51 | ## Ontwikkelaarsinformatie 52 | 53 | Stuur je pull request alsjeblieft naar de [`testing`-branch](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | Om de `testing`-branch uit te proberen, ga als volgt te werk: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | of 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **Verdere informatie over app-packaging:** 64 | -------------------------------------------------------------------------------- /README_pl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs dla YunoHost 7 | 8 | [![Poziom integracji](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Status działania](https://apps.yunohost.org/badge/state/gogs) 10 | ![Status utrzymania](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Zainstaluj Gogs z YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Przeczytaj plik README w innym języku.](./ALL_README.md)* 15 | 16 | > *Ta aplikacja pozwala na szybką i prostą instalację Gogs na serwerze YunoHost.* 17 | > *Jeżeli nie masz YunoHost zapoznaj się z [poradnikiem](https://yunohost.org/install) instalacji.* 18 | 19 | ## Przegląd 20 | 21 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Dostarczona wersja:** 0.13.2~ynh1 36 | 37 | **Demo:** 38 | 39 | ## Zrzuty ekranu 40 | 41 | ![Zrzut ekranu z Gogs](./doc/screenshots/screenshot.png) 42 | 43 | ## Dokumentacja i zasoby 44 | 45 | - Oficjalna strona aplikacji: 46 | - Oficjalna dokumentacja dla administratora: 47 | - Repozytorium z kodem źródłowym: 48 | - Sklep YunoHost: 49 | - Zgłaszanie błędów: 50 | 51 | ## Informacje od twórców 52 | 53 | Wyślij swój pull request do [gałęzi `testing`](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | Aby wypróbować gałąź `testing` postępuj zgodnie z instrukcjami: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | lub 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **Więcej informacji o tworzeniu paczek aplikacji:** 64 | -------------------------------------------------------------------------------- /README_ru.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Gogs для YunoHost 7 | 8 | [![Уровень интеграции](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![Состояние работы](https://apps.yunohost.org/badge/state/gogs) 10 | ![Состояние сопровождения](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![Установите Gogs с YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[Прочтите этот README на других языках.](./ALL_README.md)* 15 | 16 | > *Этот пакет позволяет Вам установить Gogs быстро и просто на YunoHost-сервер.* 17 | > *Если у Вас нет YunoHost, пожалуйста, посмотрите [инструкцию](https://yunohost.org/install), чтобы узнать, как установить его.* 18 | 19 | ## Обзор 20 | 21 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **Поставляемая версия:** 0.13.2~ynh1 36 | 37 | **Демо-версия:** 38 | 39 | ## Снимки экрана 40 | 41 | ![Снимок экрана Gogs](./doc/screenshots/screenshot.png) 42 | 43 | ## Документация и ресурсы 44 | 45 | - Официальный веб-сайт приложения: 46 | - Официальная документация администратора: 47 | - Репозиторий кода главной ветки приложения: 48 | - Магазин YunoHost: 49 | - Сообщите об ошибке: 50 | 51 | ## Информация для разработчиков 52 | 53 | Пришлите Ваш запрос на слияние в [ветку `testing`](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing). 54 | 55 | Чтобы попробовать ветку `testing`, пожалуйста, сделайте что-то вроде этого: 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | или 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **Больше информации о пакетировании приложений:** 64 | -------------------------------------------------------------------------------- /README_zh_Hans.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # YunoHost 上的 Gogs 7 | 8 | [![集成程度](https://apps.yunohost.org/badge/integration/gogs)](https://ci-apps.yunohost.org/ci/apps/gogs/) 9 | ![工作状态](https://apps.yunohost.org/badge/state/gogs) 10 | ![维护状态](https://apps.yunohost.org/badge/maintained/gogs) 11 | 12 | [![使用 YunoHost 安装 Gogs](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gogs) 13 | 14 | *[阅读此 README 的其它语言版本。](./ALL_README.md)* 15 | 16 | > *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Gogs。* 17 | > *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* 18 | 19 | ## 概况 20 | 21 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 22 | 23 | ### Features 24 | 25 | - User dashboard, user profile and activity timeline. 26 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 27 | - Repository Git hooks, deploy keys and Git LFS. 28 | - Repository issues, pull requests, wiki, protected branches and collaboration. 29 | - Migrate and mirror repositories with wiki from other code hosts. 30 | - Web editor for quick editing repository files and wiki. 31 | - Jupyter Notebook and PDF rendering. 32 | - Authentication via SMTP, LDAP. 33 | 34 | 35 | **分发版本：** 0.13.2~ynh1 36 | 37 | **演示：** 38 | 39 | ## 截图 40 | 41 | ![Gogs 的截图](./doc/screenshots/screenshot.png) 42 | 43 | ## 文档与资源 44 | 45 | - 官方应用网站： 46 | - 官方管理文档： 47 | - 上游应用代码库： 48 | - YunoHost 商店： 49 | - 报告 bug： 50 | 51 | ## 开发者信息 52 | 53 | 请向 [`testing` 分支](https://github.com/YunoHost-Apps/gogs_ynh/tree/testing) 发送拉取请求。 54 | 55 | 如要尝试 `testing` 分支，请这样操作： 56 | 57 | ```bash 58 | sudo yunohost app install https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 59 | 或 60 | sudo yunohost app upgrade gogs -u https://github.com/YunoHost-Apps/gogs_ynh/tree/testing --debug 61 | ``` 62 | 63 | **有关应用打包的更多信息：** 64 | -------------------------------------------------------------------------------- /conf/app.ini: -------------------------------------------------------------------------------- 1 | ;https://github.com/gogits/gogs/blob/master/conf/app.ini 2 | 3 | ; The brand name of the application, can be your company or team name. 4 | BRAND_NAME = Gogs 5 | ; The system user who should be running the applications. It has no effect on Windows, 6 | ; otherwise, it should match the value of $USER environment variable. 7 | RUN_USER = __APP__ 8 | ; The running mode of the application, can be either "dev", "prod" or "test". 9 | RUN_MODE = prod 10 | 11 | [server] 12 | ; The public-facing URL for the application. 13 | EXTERNAL_URL = https://__URL__/ 14 | ; The public-facing domain name for the application. 15 | DOMAIN = __DOMAIN__ 16 | ; The protocol that is used to serve direct traffic to the application. 17 | ; Currently supports "http", "https", "fcgi" and "unix". 18 | PROTOCOL = http 19 | ; The address to be listened by the application. 20 | HTTP_ADDR = 127.0.0.1 21 | ; The port number to be listened by the application. 22 | HTTP_PORT = __PORT__ 23 | ; Generate steps: 24 | ; $ ./gogs cert -ca=true -duration=8760h0m0s -host=myhost.example.com 25 | ; 26 | ; Or from a .pfx file exported from the Windows certificate store (do 27 | ; not forget to export the private key): 28 | ; $ openssl pkcs12 -in cert.pfx -out cert.pem -nokeys 29 | ; $ openssl pkcs12 -in cert.pfx -out key.pem -nocerts -nodes 30 | CERT_FILE = custom/https/cert.pem 31 | KEY_FILE = custom/https/key.pem 32 | ; The minimum allowed TLS version, currently supports "TLS10", "TLS11", "TLS12", and "TLS13". 33 | TLS_MIN_VERSION = TLS12 34 | ; File permission when serve traffic via Unix domain socket. 35 | UNIX_SOCKET_PERMISSION = 666 36 | ; Local (DMZ) URL for workers (e.g. SSH update) accessing web service. 37 | ; In most cases you do not need to change the default value. 38 | ; Alter it only if your SSH server node is not the same as HTTP node. 39 | LOCAL_ROOT_URL = %(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/ 40 | 41 | ; Whether to disable using CDN for static files regardless. 42 | OFFLINE_MODE = false 43 | ; Whether to disable logging in router. 44 | DISABLE_ROUTER_LOG = true 45 | ; Whether to enable application level GZIP compression. 46 | ENABLE_GZIP = false 47 | 48 | ; The path for storing application specific data. 49 | APP_DATA_PATH = __DATA_DIR__/data 50 | ; Whether to enable to load assets (i.e. "conf", "templates", "public") from disk instead of embedded bindata. 51 | LOAD_ASSETS_FROM_DISK = false 52 | 53 | ; The landing page URL for anonymous users, the value should not include 54 | ; subpath that is handled by the reverse proxy. 55 | LANDING_URL = /explore 56 | 57 | ; Whether to disable SSH access to the application entirely. 58 | DISABLE_SSH = false 59 | ; The domain name to be exposed in SSH clone URL. 60 | SSH_DOMAIN = %(DOMAIN)s 61 | ; The port number to be exposed in SSH clone URL. 62 | SSH_PORT = 22 63 | ; The path of SSH root directory, default is "$HOME/.ssh". 64 | SSH_ROOT_PATH = 65 | ; The path to ssh-keygen, default is "ssh-keygen" and let shell find out which one to call. 66 | SSH_KEYGEN_PATH = ssh-keygen 67 | ; The directory to create temporary files when test a public key using ssh-keygen, 68 | ; default is the system temporary directory. 69 | SSH_KEY_TEST_PATH = 70 | ; Whether to check minimum public key size with corresponding type. 71 | MINIMUM_KEY_SIZE_CHECK = false 72 | ; Whether to rewrite "~/.ssh/authorized_keys" file at start, ignored when use builtin SSH server. 73 | REWRITE_AUTHORIZED_KEYS_AT_START = false 74 | ; Whether to start a builtin SSH server. 75 | START_SSH_SERVER = false 76 | ; The network interface for builtin SSH server to listen on. 77 | SSH_LISTEN_HOST = 0.0.0.0 78 | ; The port number for builtin SSH server to listen on. 79 | SSH_LISTEN_PORT = %(SSH_PORT)s 80 | ; The list of accepted ciphers for connections to builtin SSH server. 81 | SSH_SERVER_CIPHERS = aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, arcfour256, arcfour128 82 | ; The list of accepted MACs for connections to builtin SSH server. 83 | SSH_SERVER_MACS = hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1 84 | 85 | ; Define allowed algorithms and their minimum key length (use -1 to disable a type). 86 | [ssh.minimum_key_sizes] 87 | ED25519 = 256 88 | ECDSA = 256 89 | RSA = 2048 90 | DSA = 1024 91 | 92 | [repository] 93 | ; The root path for storing managed repositories, default is "~/gogs-repositories" 94 | ROOT = __DATA_DIR__/repositories 95 | ; The script type server supports, sometimes could be "sh". 96 | SCRIPT_TYPE = bash 97 | ; Default ANSI charset for an unrecognized charset. 98 | ANSI_CHARSET = 99 | ; Whether to force every new repository to be private. 100 | FORCE_PRIVATE = false 101 | ; The global limit of number of repositories a user can create, -1 means no limit. 102 | MAX_CREATION_LIMIT = -1 103 | ; Preferred Licenses to place at the top of the list. 104 | ; Name must match file name in "conf/license" or "custom/conf/license". 105 | PREFERRED_LICENSES = Apache License 2.0, MIT License 106 | ; Whether to disable Git interaction with repositories via HTTP/HTTPS protocol. 107 | DISABLE_HTTP_GIT = false 108 | ; Whether to enable ability to migrate repository by server local path. 109 | ENABLE_LOCAL_PATH_MIGRATION = false 110 | ; Whether to enable render mode for raw file. There are potential security risks. 111 | ENABLE_RAW_FILE_RENDER_MODE = false 112 | ; The maximum number of goroutines that can be run at the same time for a single 113 | ; fetch request. Usually, the value depend of how many CPU (cores) you have. If 114 | ; the value is non-positive, it matches the number of CPUs available to the application. 115 | COMMITS_FETCH_CONCURRENCY = 0 116 | 117 | [repository.editor] 118 | ; List of file extensions that should have line wraps in the CodeMirror editor. 119 | ; Separate extensions with a comma. 120 | LINE_WRAP_EXTENSIONS = .txt,.md,.markdown,.mdown,.mkd 121 | ; Valid file modes that have a preview API associated with them, such as "/api/v1/markdown". 122 | ; Separate values by commas. Preview tab in edit mode won't show if the file extension doesn't match. 123 | PREVIEWABLE_FILE_MODES = markdown 124 | 125 | [repository.upload] 126 | ; Whether to enable repository file uploads. 127 | ENABLED = true 128 | ; The path to temporarily store uploads (content under this path gets wiped out on every start). 129 | TEMP_PATH = __DATA_DIR__/data/tmp/uploads 130 | ; File types that are allowed to be uploaded, e.g. "image/jpeg|image/png". Leave empty to allow any file type. 131 | ALLOWED_TYPES = 132 | ; The maximum size of each file in MB. 133 | FILE_MAX_SIZE = 3 134 | ; The maximum number of files per upload. 135 | MAX_FILES = 5 136 | 137 | [database] 138 | ; The database backend, either "postgres", "mysql" "sqlite3" or "mssql". 139 | ; You can connect to TiDB with MySQL protocol. 140 | TYPE = mysql 141 | HOST = 127.0.0.1:3306 142 | NAME = __DB_NAME__ 143 | USER = __DB_USER__ 144 | PASSWORD = __DB_PWD__ 145 | ; For "postgres" only, either "disable", "require" or "verify-full". 146 | SSL_MODE = disable 147 | ; For "sqlite3" only, make sure to use absolute path. 148 | PATH = data/gogs.db 149 | ; The maximum open connections of the pool. 150 | MAX_OPEN_CONNS = 30 151 | ; The maximum idle connections of the pool. 152 | MAX_IDLE_CONNS = 30 153 | 154 | [security] 155 | ; Whether to show the install page, set this to "true" to bypass it. 156 | INSTALL_LOCK = true 157 | ; The secret to encrypt cookie values, 2FA code, etc. 158 | ; !!CHANGE THIS TO KEEP YOUR USER DATA SAFE!! 159 | SECRET_KEY = __KEY__ 160 | ; The days remembered for auto-login. 161 | LOGIN_REMEMBER_DAYS = 7 162 | ; The cookie name to store auto-login information. 163 | COOKIE_REMEMBER_NAME = gogs_incredible 164 | ; The cookie name to store logged in username. 165 | COOKIE_USERNAME = gogs_awesome 166 | ; Whether to set secure cookie. 167 | COOKIE_SECURE = false 168 | ; Whether to set cookie to indicate user login status. 169 | ENABLE_LOGIN_STATUS_COOKIE = false 170 | ; The cookie name to store user login status. 171 | LOGIN_STATUS_COOKIE_NAME = login_status 172 | 173 | [email] 174 | ; Whether to enable the email service. 175 | ENABLED = true 176 | ; The prefix prepended to the subject line. 177 | SUBJECT_PREFIX = `[%(BRAND_NAME)s] ` 178 | ; The SMTP server with its port, e.g. smtp.mailgun.org:587, smtp.gmail.com:587, smtp.qq.com:465 179 | ; If the port ends is "465", SMTPS will be used. Using STARTTLS on port 587 is recommended per RFC 6409. 180 | ; If the server supports STARTTLS it will always be used. 181 | HOST = 127.0.0.1:25 182 | ; The email from address (RFC 5322). This can be just an email address, or the `"Name" ` format. 183 | FROM = "Gogs" 184 | ; The login user. 185 | USER = "Gogs" 186 | ; The login password. 187 | PASSWORD = 188 | 189 | ; Whether to disable HELO operation when the hostname is different. 190 | DISABLE_HELO = 191 | ; The custom hostname for HELO operation, default is from system. 192 | HELO_HOSTNAME = 193 | 194 | ; Whether to skip verifying the certificate of the server. Only use this for self-signed certificates. 195 | SKIP_VERIFY = true 196 | ; Whether to use client certificates. 197 | USE_CERTIFICATE = false 198 | CERT_FILE = custom/email/cert.pem 199 | KEY_FILE = custom/email/key.pem 200 | 201 | ; Whether to use "text/plain" as content format. 202 | USE_PLAIN_TEXT = false 203 | ; Whether to attach a plaintext alternative to the MIME message while sending HTML emails. 204 | ; It is used to support older mail clients and make spam filters happier. 205 | ADD_PLAIN_TEXT_ALT = false 206 | 207 | [auth] 208 | ; The valid duration of activate code in minutes. 209 | ACTIVATE_CODE_LIVES = 180 210 | ; The valid duration of reset password code in minutes. 211 | RESET_PASSWORD_CODE_LIVES = 180 212 | ; Whether to require email confirmation for adding new email addresses. 213 | ; Enable this option will also require user to confirm the email for registration. 214 | REQUIRE_EMAIL_CONFIRMATION = false 215 | ; Whether to disallow anonymous users visiting the site. 216 | REQUIRE_SIGNIN_VIEW = false 217 | ; Whether to disable self-registration. When disabled, accounts would have to be created by admins. 218 | DISABLE_REGISTRATION = true 219 | ; Whether to enable captcha validation for registration 220 | ENABLE_REGISTRATION_CAPTCHA = true 221 | 222 | ; Whether to enable reverse proxy authentication via HTTP header. 223 | ENABLE_REVERSE_PROXY_AUTHENTICATION = false 224 | ; Whether to automatically create new users for reverse proxy authentication. 225 | ENABLE_REVERSE_PROXY_AUTO_REGISTRATION = false 226 | ; The HTTP header used as username for reverse proxy authentication. 227 | REVERSE_PROXY_AUTHENTICATION_HEADER = X-WEBAUTH-USER 228 | 229 | [user] 230 | ; Whether to enable email notifications for users. 231 | ENABLE_EMAIL_NOTIFICATION = false 232 | 233 | [session] 234 | ; The session provider, either "memory", "file", or "redis". 235 | PROVIDER = memory 236 | ; The configuration for respective provider: 237 | ; - memory: does not need any config yet 238 | ; - file: session file path, e.g. `data/sessions` 239 | ; - redis: network=tcp,addr=:6379,password=macaron,db=0,pool_size=100,idle_timeout=180 240 | PROVIDER_CONFIG = data/sessions 241 | ; The cookie name to store the session identifier. 242 | COOKIE_NAME = i_like_gogs 243 | ; Whether to set cookie in HTTPS only. 244 | COOKIE_SECURE = false 245 | ; The GC interval in seconds for session data. 246 | GC_INTERVAL = 3600 247 | ; The maximum life time in seconds for a session. 248 | MAX_LIFE_TIME = 86400 249 | ; The cookie name for CSRF token. 250 | CSRF_COOKIE_NAME = _csrf 251 | 252 | [cache] 253 | ; The cache adapter, either "memory", "redis", or "memcache". 254 | ADAPTER = memory 255 | ; For "memory" only, GC interval in seconds. 256 | INTERVAL = 60 257 | ; For "redis" and "memcache", connection host address: 258 | ; - redis: network=tcp,addr=:6379,password=macaron,db=0,pool_size=100,idle_timeout=180 259 | ; - memcache: `127.0.0.1:11211` 260 | HOST = 261 | 262 | [http] 263 | ; The value for "Access-Control-Allow-Origin" header, default is not to present. 264 | ACCESS_CONTROL_ALLOW_ORIGIN = 265 | 266 | [lfs] 267 | ; The storage backend for uploading new objects. 268 | STORAGE = local 269 | ; The root path to store LFS objects on local file system. 270 | OBJECTS_PATH = __DATA_DIR__/data/lfs-objects 271 | 272 | [attachment] 273 | ; Whether to enabled upload attachments in general. 274 | ENABLED = true 275 | ; The path to store attachments on the file system. 276 | PATH = __DATA_DIR__/data/attachments 277 | ; File types that are allowed to be uploaded, e.g. "image/jpeg|image/png". Leave empty to allow any file type. 278 | ALLOWED_TYPES = image/jpeg|image/png 279 | ; The maximum size of each file in MB. 280 | MAX_SIZE = 4 281 | ; The maximum number of files per upload. 282 | MAX_FILES = 5 283 | 284 | [release.attachment] 285 | ; Whether to enabled upload attachments for releases. 286 | ENABLED = true 287 | ; File types that are allowed to be uploaded, e.g. "image/jpeg|image/png". Leave empty to allow any file type. 288 | ALLOWED_TYPES = */* 289 | ; The maximum size of each file in MB. 290 | MAX_SIZE = 32 291 | ; The maximum number of files per upload. 292 | MAX_FILES = 10 293 | 294 | [time] 295 | ; Specifies the format for fully outputed dates. 296 | ; Values should be one of the following: 297 | ; ANSIC, UnixDate, RubyDate, RFC822, RFC822Z, RFC850, RFC1123, RFC1123Z, RFC3339, RFC3339Nano, Kitchen, Stamp, StampMilli, StampMicro and StampNano. 298 | ; For more information about the format see http://golang.org/pkg/time/#pkg-constants. 299 | FORMAT = RFC1123 300 | 301 | [picture] 302 | ; The path to store user avatars on the file system. 303 | AVATAR_UPLOAD_PATH = __DATA_DIR__/data/avatars 304 | ; The path to store repository avatars on the file system. 305 | REPOSITORY_AVATAR_UPLOAD_PATH = __DATA_DIR__/data/repo-avatars 306 | ; Chinese users can use a custom avatar source, such as http://cn.gravatar.com/avatar/. 307 | GRAVATAR_SOURCE = gravatar 308 | ; Whether to disable Gravatar, this value will be forced to be true in offline mode. 309 | DISABLE_GRAVATAR = false 310 | ; Whether to enable federated avatar lookup uses DNS to discover avatar associated 311 | ; with emails, see https://www.libravatar.org for details. 312 | ; This value will be forced to be false in offline mode or when Gravatar is disabled. 313 | ENABLE_FEDERATED_AVATAR = false 314 | 315 | [markdown] 316 | ; Whether to enable hard line break extension. 317 | ENABLE_HARD_LINE_BREAK = false 318 | ; The list of custom URL schemes that are allowed as links when rendering Markdown. 319 | ; For example, "git" (for "git://") and "magnet" (for "magnet://"). 320 | CUSTOM_URL_SCHEMES = 321 | ; The list of file extensions that should be rendered/edited as Markdown. 322 | ; Separate extensions with a comma. To render files with no extension as markdown, just put a comma. 323 | FILE_EXTENSIONS = .md,.markdown,.mdown,.mkd 324 | 325 | [smartypants] 326 | ; Whether to enable the Smartypants extension. 327 | ENABLED = false 328 | FRACTIONS = true 329 | DASHES = true 330 | LATEX_DASHES = true 331 | ANGLED_QUOTES = true 332 | 333 | [admin] 334 | ; Whether to disable regular (non-admin) users to create organizations. 335 | DISABLE_REGULAR_ORG_CREATION = false 336 | 337 | [webhook] 338 | ; The list of enabled types for users to use, can be "gogs", "slack", "discord", "dingtalk". 339 | TYPES = gogs, slack, discord, dingtalk 340 | ; Deliver timeout in seconds. 341 | DELIVER_TIMEOUT = 15 342 | ; Whether to allow insecure certification. 343 | SKIP_TLS_VERIFY = false 344 | ; The number of history information in each page. 345 | PAGING_NUM = 10 346 | 347 | ; General settings of loggers. 348 | [log] 349 | ; The root path for all log files, default is "log/" subdirectory. 350 | ROOT_PATH =/var/log/__APP__ 351 | ; Can be "console", "file", "slack" and "discord". 352 | ; Use comma to separate multiple modes, e.g. "console, file" 353 | MODE = file 354 | ; Buffer length of channel, keep it as it is if you don't know what it is. 355 | BUFFER_LEN = 100 356 | ; Either "Trace", "Info", "Warn", "Error", "Fatal", default is "Trace" 357 | LEVEL = Warn 358 | 359 | ; For "console" mode only 360 | [log.console] 361 | ; Comment out to inherit 362 | ; LEVEL = 363 | 364 | ; For "file" mode only 365 | [log.file] 366 | ; Comment out to inherit 367 | ; LEVEL = 368 | ; Whether to enable automated log rotate (switch of following options). 369 | LOG_ROTATE = true 370 | ; Whether to segment log files daily. 371 | DAILY_ROTATE = true 372 | ; The maximum size shift of single file, default is 28 means 1 << 28 = 256MB. 373 | MAX_SIZE_SHIFT = 28 374 | ; The maximum number of lines of single file. 375 | MAX_LINES = 1000000 376 | ; The expired days of log file (delete after max days). 377 | MAX_DAYS = 7 378 | 379 | ; For "slack" mode only 380 | [log.slack] 381 | ; Comment out to inherit 382 | ; LEVEL = 383 | ; Webhook URL 384 | URL = 385 | 386 | [log.discord] 387 | ; Comment out to inherit 388 | ; LEVEL = 389 | ; Webhook URL 390 | URL = 391 | ; The username to be displayed in notification. 392 | USERNAME = %(BRAND_NAME)s 393 | 394 | [log.xorm] 395 | ; Enable file rotation 396 | ROTATE = true 397 | ; Rotate every day 398 | ROTATE_DAILY = true 399 | ; Rotate once file size excesses x MB 400 | MAX_SIZE = 100 401 | ; Maximum days to keep logger files 402 | MAX_DAYS = 3 403 | 404 | [log.gorm] 405 | ; Whether to enable file rotation. 406 | ROTATE = true 407 | ; Whether to rotate file every day. 408 | ROTATE_DAILY = true 409 | ; The maximum file size in MB before next rotate. 410 | MAX_SIZE = 100 411 | ; The maximum days to keep files. 412 | MAX_DAYS = 3 413 | 414 | [cron] 415 | ; Enable running cron tasks periodically. 416 | ENABLED = true 417 | ; Run cron tasks when Gogs starts. 418 | RUN_AT_START = false 419 | 420 | [cron.update_mirrors] 421 | ; Defines how often the mirror syncer checks if any mirror needs to be synchronized (based on the mirror update interval). 422 | SCHEDULE = @every 10m 423 | 424 | ; Repository health check 425 | [cron.repo_health_check] 426 | SCHEDULE = @every 24h 427 | TIMEOUT = 60s 428 | ; Arguments for command 'git fsck', e.g. "--unreachable --tags" 429 | ; see more on http://git-scm.com/docs/git-fsck/1.7.5 430 | ARGS = 431 | 432 | ; Check repository statistics 433 | [cron.check_repo_stats] 434 | RUN_AT_START = true 435 | SCHEDULE = @every 24h 436 | 437 | ; Cleanup repository archives 438 | [cron.repo_archive_cleanup] 439 | RUN_AT_START = false 440 | SCHEDULE = @every 24h 441 | ; Time duration to check if archive should be cleaned 442 | OLDER_THAN = 24h 443 | 444 | [git] 445 | ; Disables highlight of added and removed changes 446 | DISABLE_DIFF_HIGHLIGHT = false 447 | ; Max number of files shown in diff view 448 | MAX_GIT_DIFF_FILES = 100 449 | ; Max number of lines allowed of a single file in diff view 450 | MAX_GIT_DIFF_LINES = 1000 451 | ; Max number of characters of a line allowed in diff view 452 | MAX_GIT_DIFF_LINE_CHARACTERS = 2000 453 | ; Arguments for command 'git gc', e.g. "--aggressive --auto" 454 | ; see more on http://git-scm.com/docs/git-gc/1.7.5 455 | GC_ARGS = 456 | 457 | ; Operation timeout in seconds 458 | [git.timeout] 459 | MIGRATE = 600 460 | MIRROR = 300 461 | CLONE = 300 462 | PULL = 300 463 | DIFF = 60 464 | GC = 60 465 | 466 | [mirror] 467 | ; Defines the default interval (in hours) until the next sync for a mirror (after a successful mirror sync). 468 | ; It can be overridden individually for each mirror repository in the settings. 469 | DEFAULT_INTERVAL = 8 470 | 471 | [api] 472 | ; Max number of items will response in a page 473 | MAX_RESPONSE_ITEMS = 50 474 | 475 | [ui] 476 | ; Number of repositories that are showed in one explore page 477 | EXPLORE_PAGING_NUM = 20 478 | ; Number of issues that are showed in one page 479 | ISSUE_PAGING_NUM = 10 480 | ; Number of maximum commits showed in one activity feed 481 | FEED_MAX_COMMIT_NUM = 5 482 | ; Value of "theme-color" meta tag, used by Android >= 5.0 483 | ; An invalid color like "none" or "disable" will have the default style 484 | ; More info: https://developers.google.com/web/updates/2014/11/Support-for-theme-color-in-Chrome-39-for-Android 485 | THEME_COLOR_META_TAG = `#ff5343` 486 | ; Max size in bytes of files to be displayed (default is 8MB) 487 | MAX_DISPLAY_FILE_SIZE = 8388608 488 | 489 | [ui.admin] 490 | ; Number of users that are showed in one page 491 | USER_PAGING_NUM = 50 492 | ; Number of repos that are showed in one page 493 | REPO_PAGING_NUM = 50 494 | ; Number of notices that are showed in one page 495 | NOTICE_PAGING_NUM = 25 496 | ; Number of organization that are showed in one page 497 | ORG_PAGING_NUM = 50 498 | 499 | [ui.user] 500 | ; Number of repos that are showed in one page 501 | REPO_PAGING_NUM = 15 502 | ; Number of news feeds that are showed in one page 503 | NEWS_FEED_PAGING_NUM = 20 504 | ; Number of commits that are showed in one page 505 | COMMITS_PAGING_NUM = 30 506 | 507 | [prometheus] 508 | ; Whether to enable Prometheus metrics. 509 | ENABLED = false 510 | ; Whether to enable HTTP Basic Authentication to protect metrics data. 511 | ENABLE_BASIC_AUTH = false 512 | ; The username for HTTP Basic Authentication. 513 | BASIC_AUTH_USERNAME = 514 | ; The password for HTTP Basic Authentication. 515 | BASIC_AUTH_PASSWORD = 516 | 517 | ; Extension mapping to highlight class 518 | ; e.g. .toml=ini 519 | [highlight.mapping] 520 | 521 | [i18n] 522 | LANGS = en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,ja-JP,es-ES,pt-BR,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sr-SP,sv-SE,ko-KR,gl-ES,uk-UA,en-GB,hu-HU,sk-SK,id-ID,fa-IR,vi-VN,pt-PT 523 | NAMES = English,简体中文,繁體中文（香港）,繁體中文（臺灣）,Deutsch,français,Nederlands,latviešu,русский,日本語,español,português do Brasil,polski,български,italiano,suomi,Türkçe,čeština,српски,svenska,한국어,galego,українська,English (United Kingdom),Magyar,Slovenčina,Indonesian,Persian,Vietnamese,português 524 | 525 | ; Used for datetimepicker 526 | [i18n.datelang] 527 | en-US = en 528 | zh-CN = zh 529 | zh-HK = zh-TW 530 | zh-TW = zh-TW 531 | de-DE = de 532 | fr-FR = fr 533 | nl-NL = nl 534 | lv-LV = lv 535 | ru-RU = ru 536 | ja-JP = ja 537 | es-ES = es 538 | pt-BR = pt-BR 539 | pl-PL = pl 540 | bg-BG = bg 541 | it-IT = it 542 | fi-FI = fi 543 | tr-TR = tr 544 | cs-CZ = cs-CZ 545 | sr-SP = sr 546 | sv-SE = sv 547 | ko-KR = ko 548 | gl-ES = gl 549 | uk-UA = uk 550 | en-GB = en-GB 551 | hu-HU = hu 552 | sk-SK = sk 553 | id-ID = id 554 | fa-IR = fa 555 | vi-VN = vi 556 | pt-PT = pt 557 | 558 | [other] 559 | SHOW_FOOTER_BRANDING = false 560 | ; Show time of template execution in the footer 561 | SHOW_FOOTER_TEMPLATE_LOAD_TIME = true 562 | -------------------------------------------------------------------------------- /conf/ldap.conf: -------------------------------------------------------------------------------- 1 | # This is an example of LDAP (BindDN) authentication 2 | # 3 | id = 1 4 | type = ldap_bind_dn 5 | name = YunoHost LDAP 6 | is_activated = true 7 | 8 | [config] 9 | host = localhost 10 | port = 389 11 | # 0 - Unencrypted, 1 - LDAPS, 2 - StartTLS 12 | security_protocol = 0 13 | skip_verify = false 14 | bind_dn = 15 | bind_password = 16 | user_base = ou=users,dc=yunohost,dc=org 17 | attribute_username = uid 18 | attribute_name = givenName 19 | attribute_surname = sn 20 | attribute_mail = mail 21 | attributes_in_bind = false 22 | filter = (&(objectClass=posixAccount)(uid=%s)) 23 | admin_filter = (uid=__ADMIN__) 24 | group_enabled = false 25 | group_dn = 26 | group_filter = 27 | group_member_uid = 28 | user_uid = uid -------------------------------------------------------------------------------- /conf/nginx.conf: -------------------------------------------------------------------------------- 1 | #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; 2 | location __PATH__/ { 3 | 4 | proxy_pass http://127.0.0.1:__PORT__/; 5 | proxy_set_header Host $host; 6 | proxy_buffering off; 7 | fastcgi_param REMOTE_USER $remote_user; 8 | client_max_body_size 200M; 9 | proxy_set_header X-Real-IP $remote_addr; 10 | 11 | # Include SSOWAT user panel. 12 | include conf.d/yunohost_panel.conf.inc; 13 | } 14 | -------------------------------------------------------------------------------- /conf/systemd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Gogs: Go Git Service 3 | After=syslog.target network.target mysql.service slapd.service redis.service 4 | 5 | [Service] 6 | Type=simple 7 | User=__APP__ 8 | Group=__APP__ 9 | WorkingDirectory=__DATA_DIR__ 10 | ExecStart=__INSTALL_DIR__/gogs web 11 | Restart=always 12 | Environment=USER=__APP__ HOME=__DATA_DIR__ 13 | 14 | [Install] 15 | WantedBy=multi-user.target 16 | 17 | # Sandboxing options to harden security 18 | # Depending on specificities of your service/app, you may need to tweak these 19 | # .. but this should be a good baseline 20 | # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html 21 | NoNewPrivileges=yes 22 | PrivateTmp=yes 23 | PrivateDevices=yes 24 | RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 25 | RestrictNamespaces=yes 26 | RestrictRealtime=yes 27 | DevicePolicy=closed 28 | ProtectSystem=full 29 | ProtectControlGroups=yes 30 | ProtectKernelModules=yes 31 | ProtectKernelTunables=yes 32 | LockPersonality=yes 33 | SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap 34 | 35 | # Denying access to capabilities that should not be relevant for webapps 36 | # Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html 37 | CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD 38 | CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE 39 | CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT 40 | CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK 41 | CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM 42 | CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG 43 | CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE 44 | CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW 45 | CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 46 | 47 | [Install] 48 | WantedBy=multi-user.target 49 | -------------------------------------------------------------------------------- /doc/ADMIN.md: -------------------------------------------------------------------------------- 1 | ## Notes on SSH usage 2 | 3 | If you want to use Gogs with SSH and be able to pull/push with you SSH key, your SSH daemon must be properly configured to use private/public keys. Here is a sample configuration of `/etc/ssh/sshd_config` that works with Gogs: 4 | 5 | ```bash 6 | PubkeyAuthentication yes 7 | AuthorizedKeysFile %h/.ssh/authorized_keys 8 | ChallengeResponseAuthentication no 9 | PasswordAuthentication no 10 | UsePAM no 11 | ``` 12 | 13 | You also need to add your public key to your Gogs profile. 14 | 15 | If you use SSH on another port than 22, you need to add theses lines to your SSH config in `~/.ssh/config`: 16 | 17 | ```bash 18 | Host domain.tld 19 | port 2222 # change this with the port you use 20 | ``` 21 | 22 | ## Private Mode 23 | 24 | Actually it's possible to access to the Git repositories by the `git` command over HTTP also in private mode installation. It's important to know that in this mode the repository could be ALSO getted if you don't set the repository as private in the repos settings. 25 | -------------------------------------------------------------------------------- /doc/DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | Gogs (Go Git Service) is a git-based multiplatform forge written in Go. Its particularity is that it is light and can run on an ARM card, which makes it suitable for self-hosting. Gogs has a web interface similar to that of GitHub. 2 | 3 | ### Features 4 | 5 | - User dashboard, user profile and activity timeline. 6 | - Repository and organization webhooks, including Slack, Discord and Dingtalk. 7 | - Repository Git hooks, deploy keys and Git LFS. 8 | - Repository issues, pull requests, wiki, protected branches and collaboration. 9 | - Migrate and mirror repositories with wiki from other code hosts. 10 | - Web editor for quick editing repository files and wiki. 11 | - Jupyter Notebook and PDF rendering. 12 | - Authentication via SMTP, LDAP. 13 | -------------------------------------------------------------------------------- /doc/DESCRIPTION_fr.md: -------------------------------------------------------------------------------- 1 | Gogs (Go Git Service) est une forge multiplateforme basée sur git écrite en Go. Sa particularité est d’être léger et pouvant fonctionner sur carte ARM, ce qui fait qu’il est adapté à l’auto-hébergement. Gogs a une interface web similaire à celle de GitHub. 2 | -------------------------------------------------------------------------------- /doc/screenshots/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/YunoHost-Apps/gogs_ynh/95aa553c923a1aa8dd5c06c2550ea6979e54a056/doc/screenshots/screenshot.png -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json 2 | packaging_format = 2 3 | 4 | id = "gogs" 5 | name = "Gogs" 6 | description.en = "Lightweight self-hosted Git forge" 7 | description.fr = "Forge Git légère auto-hébergé" 8 | 9 | version = "0.13.2~ynh1" 10 | 11 | maintainers = [] 12 | 13 | [upstream] 14 | license = "MIT" 15 | website = "http://gogs.io" 16 | demo = "https://try.gogs.io/user/login" 17 | admindoc = "https://gogs.io/docs" 18 | code = "https://github.com/gogs/gogs" 19 | 20 | [integration] 21 | yunohost = ">= 11.2" 22 | architectures = ["amd64", "arm64"] 23 | multi_instance = true 24 | 25 | ldap = true 26 | 27 | sso = true 28 | 29 | disk = "50M" 30 | ram.build = "50M" 31 | ram.runtime = "50M" 32 | 33 | [install] 34 | [install.domain] 35 | type = "domain" 36 | 37 | [install.path] 38 | type = "path" 39 | default = "/gogs" 40 | 41 | [install.admin] 42 | type = "user" 43 | 44 | [install.init_main_permission] 45 | type = "group" 46 | default = "visitors" 47 | 48 | [resources] 49 | 50 | [resources.sources] 51 | [resources.sources.main] 52 | amd64.url = "https://github.com/gogs/gogs/releases/download/v0.13.2/gogs_0.13.2_linux_amd64.tar.gz" 53 | amd64.sha256 = "701084567c20e3e0a5dab511fefc933d4310d4ab96cdf4d80dd488a91f6de170" 54 | arm64.url = "https://github.com/gogs/gogs/releases/download/v0.13.2/gogs_0.13.2_linux_armv8.tar.gz" 55 | arm64.sha256 = "8386b3062f54eb586ea3656c0019944e09ce76e2498f43e4f7d3a306841af55f" 56 | 57 | autoupdate.strategy = "latest_github_release" 58 | autoupdate.asset.amd64 = "gogs_.*_linux_amd64.tar.gz" 59 | autoupdate.asset.arm64 = "gogs_.*_linux_armv8.tar.gz" 60 | 61 | [resources.ports] 62 | 63 | [resources.system_user] 64 | 65 | [resources.install_dir] 66 | 67 | [resources.data_dir] 68 | subdirs = ["data/repositories", "data/avatars", "data/attachments"] 69 | 70 | [resources.permissions] 71 | main.url = "/" 72 | 73 | [resources.apt] 74 | packages = "mariadb-server" 75 | 76 | [resources.database] 77 | type = "mysql" 78 | -------------------------------------------------------------------------------- /scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # COMMON VARIABLES 5 | #================================================= 6 | -------------------------------------------------------------------------------- /scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source ../settings/scripts/_common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # DECLARE DATA AND CONF FILES TO BACKUP 8 | #================================================= 9 | ynh_print_info --message="Declaring files to be backed up..." 10 | 11 | #================================================= 12 | # BACKUP THE APP MAIN DIR 13 | #================================================= 14 | 15 | ynh_backup --src_path="$install_dir" 16 | 17 | #================================================= 18 | # BACKUP THE DATA DIR 19 | #================================================= 20 | 21 | ynh_backup --src_path="$data_dir" --is_big 22 | 23 | #================================================= 24 | # BACKUP THE NGINX CONFIGURATION 25 | #================================================= 26 | 27 | ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" 28 | 29 | ynh_backup --src_path="/etc/logrotate.d/$app" 30 | 31 | ynh_backup --src_path="/etc/systemd/system/$app.service" 32 | 33 | ynh_backup --src_path="/var/log/$app" 34 | 35 | #================================================= 36 | # BACKUP THE MYSQL DATABASE 37 | #================================================= 38 | ynh_print_info --message="Backing up the MySQL database..." 39 | 40 | ynh_mysql_dump_db --database="$db_name" > db.sql 41 | 42 | #================================================= 43 | # END OF SCRIPT 44 | #================================================= 45 | 46 | ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." 47 | -------------------------------------------------------------------------------- /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 --message="Stopping a systemd service..." --weight=2 10 | 11 | ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" 12 | 13 | #================================================= 14 | # MODIFY URL IN NGINX CONF 15 | #================================================= 16 | ynh_script_progression --message="Updating NGINX web server configuration..." --weight=3 17 | 18 | ynh_change_url_nginx_config 19 | 20 | #================================================= 21 | # SPECIFIC MODIFICATIONS 22 | #================================================= 23 | 24 | if [ "$path_url" = "/" ] 25 | then 26 | url="$new_domain" 27 | else 28 | url="$new_domain${new_path%/}" 29 | fi 30 | 31 | domain=$new_domain 32 | 33 | ynh_add_config --template="../conf/app.ini" --destination="$install_dir/custom/conf/app.ini" 34 | 35 | chmod 400 "$install_dir/custom/conf/app.ini" 36 | chown $app:$app "$install_dir/custom/conf/app.ini" 37 | 38 | #================================================= 39 | # START SYSTEMD SERVICE 40 | #================================================= 41 | ynh_script_progression --message="Starting a systemd service..." --weight=2 42 | 43 | ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" 44 | 45 | #================================================= 46 | # END OF SCRIPT 47 | #================================================= 48 | 49 | ynh_script_progression --message="Change of URL completed for $app" --last 50 | -------------------------------------------------------------------------------- /scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | source _common.sh 4 | source /usr/share/yunohost/helpers 5 | 6 | #================================================= 7 | # RETRIEVE ARGUMENTS FROM THE MANIFEST 8 | #================================================= 9 | 10 | key=$(ynh_string_random) 11 | ynh_app_setting_set --app=$app --key=key --value=$key 12 | 13 | #================================================= 14 | # DOWNLOAD, CHECK AND UNPACK SOURCE 15 | #================================================= 16 | ynh_script_progression --message="Setting up source files..." --weight=3 17 | 18 | ynh_setup_source --dest_dir=$install_dir 19 | 20 | mkdir -p "$install_dir/custom/conf/auth.d" 21 | 22 | chmod -R o-rwx "$install_dir" 23 | chown -R $app:www-data "$install_dir" 24 | 25 | #================================================= 26 | # ADD A CONFIGURATION 27 | #================================================= 28 | ynh_script_progression --message="Adding a configuration file..." --weight=1 29 | 30 | if [ "$path" = "/" ] 31 | then 32 | url="$domain" 33 | else 34 | url="$domain${path%/}" 35 | fi 36 | 37 | ynh_add_config --template="app.ini" --destination="$install_dir/custom/conf/app.ini" 38 | 39 | chmod 400 "$install_dir/custom/conf/app.ini" 40 | chown $app:$app "$install_dir/custom/conf/app.ini" 41 | 42 | ynh_add_config --template="ldap.conf" --destination="$install_dir/custom/conf/auth.d/ldap.conf" 43 | 44 | #================================================= 45 | # SETUP SYSTEMD 46 | #================================================= 47 | ynh_script_progression --message="Configuring a systemd service..." --weight=1 48 | 49 | ynh_add_systemd_config 50 | 51 | ynh_add_nginx_config 52 | 53 | ynh_use_logrotate 54 | 55 | chown -R $app:$app "/var/log/$app" 56 | chmod u=rwX,g=rX,o= "/var/log/$app" 57 | 58 | yunohost service add $app --description="Lightweight Git forge" --log="/var/log/$app/$app.log" 59 | 60 | #================================================= 61 | # START SYSTEMD SERVICE 62 | #================================================= 63 | ynh_script_progression --message="Starting a systemd service..." --weight=3 64 | 65 | ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" 66 | 67 | #================================================= 68 | # END OF SCRIPT 69 | #================================================= 70 | 71 | ynh_script_progression --message="Installation of $app completed" --last 72 | -------------------------------------------------------------------------------- /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 --message="Removing system configurations related to $app..." --weight=1 10 | 11 | if ynh_exec_warn_less yunohost service status $app >/dev/null; then 12 | yunohost service remove $app 13 | fi 14 | 15 | ynh_remove_systemd_config 16 | 17 | ynh_remove_logrotate 18 | 19 | ynh_remove_nginx_config 20 | 21 | #================================================= 22 | # END OF SCRIPT 23 | #================================================= 24 | 25 | ynh_script_progression --message="Removal of $app completed" --last 26 | -------------------------------------------------------------------------------- /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 --message="Restoring $app main directory..." --weight=10 10 | 11 | ynh_restore_file --origin_path="$install_dir" 12 | 13 | chmod -R o-rwx "$install_dir" 14 | chown -R $app:www-data "$install_dir" 15 | 16 | #================================================= 17 | # RESTORE THE DATA DIRECTORY 18 | #================================================= 19 | ynh_script_progression --message="Restoring the data directory..." --weight=1 20 | 21 | ynh_restore_file --origin_path="$data_dir" --not_mandatory 22 | 23 | chown -R $app:www-data "$data_dir" 24 | 25 | #================================================= 26 | # RESTORE THE MYSQL DATABASE 27 | #================================================= 28 | ynh_script_progression --message="Restoring the MySQL database..." --weight=3 29 | 30 | ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql 31 | 32 | #================================================= 33 | # RESTORE SYSTEMD 34 | #================================================= 35 | ynh_script_progression --message="Restoring the systemd configuration..." --weight=5 36 | 37 | ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" 38 | 39 | ynh_restore_file --origin_path="/etc/systemd/system/$app.service" 40 | systemctl enable $app.service --quiet 41 | 42 | ynh_restore_file --origin_path="/etc/logrotate.d/$app" 43 | 44 | ynh_restore_file --origin_path="/var/log/$app" 45 | chown -R $app:$app "/var/log/$app" 46 | chmod u=rwX,g=rX,o= "/var/log/$app" 47 | 48 | yunohost service add $app --description="Lightweight Git forge" --log="/var/log/$app/$app.log" 49 | 50 | #================================================= 51 | # START SYSTEMD SERVICE 52 | #================================================= 53 | ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 54 | 55 | ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" 56 | 57 | ynh_systemd_action --service_name=nginx --action=reload 58 | 59 | #================================================= 60 | # END OF SCRIPT 61 | #================================================= 62 | 63 | ynh_script_progression --message="Restoration completed for $app" --last 64 | -------------------------------------------------------------------------------- /scripts/upgrade: -------------------------------------------------------------------------------- 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 --message="Stopping a systemd service..." --weight=2 10 | 11 | ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" 12 | 13 | #================================================= 14 | # DOWNLOAD, CHECK AND UNPACK SOURCE 15 | #================================================= 16 | ynh_script_progression --message="Setting up source files..." --weight=3 17 | 18 | ynh_setup_source --dest_dir=$install_dir --keep="custom/conf/app.ini custom/conf/auth.d/ldap.conf" 19 | 20 | chmod -R o-rwx "$install_dir" 21 | chown -R $app:www-data "$install_dir" 22 | 23 | #================================================= 24 | # RESTORE THE PHP-FPM CONFIGURATION 25 | #================================================= 26 | ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 27 | 28 | ynh_add_systemd_config 29 | 30 | ynh_add_nginx_config 31 | 32 | ynh_use_logrotate 33 | 34 | chown -R $app:$app "/var/log/$app" 35 | chmod u=rwX,g=rX,o= "/var/log/$app" 36 | 37 | yunohost service add $app --description="Lightweight Git forge" --log="/var/log/$app/$app.log" 38 | 39 | #================================================= 40 | # START SYSTEMD SERVICE 41 | #================================================= 42 | ynh_script_progression --message="Starting a systemd service..." --weight=1 43 | 44 | ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" 45 | 46 | #================================================= 47 | # END OF SCRIPT 48 | #================================================= 49 | 50 | ynh_script_progression --message="Upgrade of $app completed" --last 51 | -------------------------------------------------------------------------------- /tests.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json 2 | test_format = 1.0 3 | 4 | [default] 5 | 6 | # ------------ 7 | # Tests to run 8 | # ------------ 9 | --------------------------------------------------------------------------------