├── .env.TEMPLATE ├── .gitignore ├── LICENSE ├── README.md ├── docker-compose.yml └── volumes ├── config └── README ├── db-import └── README └── db └── README /.env.TEMPLATE: -------------------------------------------------------------------------------- 1 | # Set your journal Tag: 2 | COMPOSE_PROJECT_NAME=journal 3 | PROJECT_DOMAIN=journal.localhost 4 | SERVERNAME=$PROJECT_DOMAIN 5 | 6 | OJS_IMAGE=ojs 7 | OJS_VERSION=3_3_0-21 8 | 9 | # IMPORTANT: Set a non used port. 10 | HTTP_PORT=8081 11 | HTTPS_PORT=8481 12 | 13 | # Remember this to fill your installation form in a clean installatio 14 | # MYSQL_VERSION=10.3 15 | MYSQL_ROOT_PASSWORD=setYourPass 16 | 17 | # OJS variables 18 | OJS_CLI_INSTALL=0 19 | OJS_DB_HOST=db 20 | OJS_DB_DRIVER=mysqli 21 | OJS_DB_USER=ojs 22 | OJS_DB_PASSWORD=setYourPass 23 | OJS_DB_NAME=ojs 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .swp 2 | .sandbox 3 | -------------------------------------------------------------------------------- /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) 2020 Public Knowledge Project 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 | docker4ojs Copyright (C) 2020 Public Knowledge Project 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 | # easyOJS - OJS in a docker 2 | 3 | 4 | | **IMPORTANT:** | 5 | |:---------------------------------------------------------| 6 | | In the Hannover sprint, we decided to mutate this repository into an **easy howto for running OJS** with the official dockerHub containers.
This is now the recommended way to run dockerized OJS in test and production. | 7 | | To be safe in case dockerHub changes it's usage terms and to test alternative CI/CD tools, we also created a [temporary gitLab repository](https://gitlab.com/pkp-org/docker), that is the one we use to build the images you can find in dockerHub. This is a temporary change as most likely in the near future, we will move back to this same repository and use gitHubActions. Sorry for the inconvenience. | 8 | | Anyway, generated in gitLab or gitHub, as long as it is a free service, we will keep pushing images to dockerHub. | 9 | 10 | Open Journal Systems (OJS) is a journal management and publishing system that has been developed by the [Public Knowledge Project](https://pkp.sfu.ca/) through its federally funded efforts to expand and improve access to research. 11 | 12 | The images in this repository are built on top of [Alpine Linux](https://alpinelinux.org/) and come in several variants (see [Versions](#versions)). 13 | 14 | This repository is a fork of the work formerly done by [Lucas Dietrich](https://github.com/lucasdiedrich/ojs) and [Marc Bria](https://github.com/marcbria/docker-ojs). 15 | 16 | This new project is maintained by [Marc Bria](https://github.com/marcbria). 17 | 18 | 19 | ## How to use 20 | 21 | ### TL;DR; 22 | 23 | Be sure you properly installed `docker` and `docker-compose` and the `docker` service is running. 24 | 25 | ``` 26 | git clone https://github.com/pkp/docker-ojs.git 27 | mv docker-ojs journalName && cd journalName 28 | mv .env.TEMPLATE .env 29 | vim .env # Set environment variables as you wish (ojs version, ports, url...) 30 | source .env && wget "https://github.com/pkp/ojs/raw/${OJS_VERSION}/config.TEMPLATE.inc.php" -O ./volumes/config/ojs.config.inc.php 31 | sudo chown 100:101 ./volumes -R && sudo chown 999:999 ./volumes/db -R # Ensure folders got the propper permissions 32 | docker compose up -d 33 | # Visit your new site and complete the installation as usual (Read about DB access credentials below, in step 5). 34 | 35 | ``` 36 | 37 | ### Extended version 38 | 39 | If you want to run it locally (or in your own server), first you need to install 40 | [docker](https://docs.docker.com/get-docker/) (even [docker-compose](https://docs.docker.com/compose/install/) it's also recommended). 41 | 42 | You can have it all up and running in less than 10 minutes following this brief howto: 43 | https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-debian-10 44 | 45 | After this, notice that for all available versions, we provide a **docker-compose** configuration file so 46 | you will be able to start a full OJS stack (web app + database containers) in 4 easy steps: 47 | 48 | 1. Clone this repository in your machine (if youprefer, you can also [download](https://github.com/pkp/docker-ojs/archive/master.zip) and unzip it): 49 | 50 | ```bash 51 | $ git clone https://github.com/pkp/docker-ojs.git 52 | $ mv docker-ojs journalName && cd journalName 53 | ``` 54 | 55 | Replace "journalName" with a short name of your journal (probably you will like to set the same value you use for COMPOSE_PROJECT_NAME variable). 56 | 57 | 2. Set your environment variables 58 | 59 | ```bash 60 | $ mv .env.TEMPLATE .env 61 | ``` 62 | 63 | Edit your .env file to fit your need to fit your needs. 64 | You will probably like to chage your OJS_VERSION, ports, and names. 65 | For a detailed description of all the environment variables take a look to ["Environment Variables"](#environment-variables) sectionj. 66 | 67 | 3. Download the ojs config file related to your desired version 68 | 69 | ```bash 70 | $ source .env && wget "https://github.com/pkp/ojs/raw/${OJS_VERSION}/config.TEMPLATE.inc.php" -O ./volumes/config/ojs.config.inc.php 71 | ``` 72 | 73 | If your are running docker on windows (with Powershell), specify the version you like to download: 74 | 75 | ```bash 76 | $ wget "https://github.com/pkp/ojs/raw/3_3_0-21/config.TEMPLATE.inc.php" -O ./volumes/config/ojs.config.inc.php 77 | ``` 78 | 79 | 4. Run the stack: 80 | ```bash 81 | $ docker compose up 82 | ``` 83 | 84 | Docker-compose will pull images from dockerHub and do all the hard work for you to rise a full functional OJS stack. 85 | If all goes as expected you will see your app_container informing apache is RUNNING successfully. 86 | 87 | ``` 88 | INFO success: apache entered RUNNING state, process has stayed up for > than 1 seconds (startsecs) 89 | ``` 90 | 91 | You can add the "-d" parameter to the call if you like to run it detached. 92 | 93 | 4. Access **http://127.0.0.1:8081** and continue through web installation process. 94 | 95 | Note that the database connection needs the following options: 96 | 97 | - **Database driver**: `mysqli` (or "mysql" if your php is lower than 7.3) 98 | - **Host**: `db` (which is the name of the container in the internal Docker network) 99 | - **Username**: `ojs` 100 | - **Password**: `setYourPass` (change with the password you set in your environment variables) 101 | - **Database name**: `ojs` 102 | - _Uncheck_ "Create new database" 103 | - _Uncheck_ "Beacon" 104 | 105 | And the "Directory for uploads:" acording to your docker-compose.yml "/var/www/files" 106 | 107 | | **TIP:** | 108 | |:---------------------| 109 | | To go through the OJS installation process automatically, set the environment variable `OJS_CLI_INSTALL=1`, and use the other .env variables to automatize the process. | 110 | 111 | That's all. Easy peasy, isn't it? 112 | 113 | Ok, let's talk talk about more complex concepts and scenarios. 114 | 115 | 138 | 139 | ## Versions 140 | 141 | Different OJS versions are combined with different versions of PHP (5 to 8...). In future we are planning to add variants with different web servers ([Apache HTTP Server](https://httpd.apache.org/), [nginx](https://nginx.org/)) and tools. 142 | 143 | _Currently, not all these combinations work! We are mostly focused in Apache2. PR are welcome_ 144 | 145 | All version tags can be found at [Docker Hub Tags tab](https://hub.docker.com/r/pkpofficial/ojs/tags/). 146 | 147 | (If no webserver is mentioned in the tag, then Apache is used). 148 | 149 | 150 | ## Environment Variables 151 | 152 | The image understand the following environment variables: 153 | 154 | | NAME | Default | Info | 155 | |:----------------------:|:------------:|:---------------------| 156 | | SERVERNAME | localhost | Used to generate httpd.conf and certificate | 157 | | OJS_IMAGE | ojs | PKP tool to be used (ojs, omp, ops). Only OJS images avaliable right now | 158 | | OJS_VERSION | 3_3_0-21 | OJS version to be deployed | 159 | | COMPOSER_PROJECT_NAME | journal | 160 | | OJS_CLI_INSTALL | 0 | Used to install ojs automatically when container starts | 161 | | OJS_DB_HOST | db | Database host | 162 | | OJS_DB_USER | ojs | Database | 163 | | OJS_DB_PASSWORD | setYourPass | Database password | 164 | | OJS_DB_NAME | ojs | Database name | 165 | | HTTP_PORT | 8081 | Http port | 166 | | HTTPS_PORT | 8481 | Https port | 167 | 168 | 169 | _**Note:** OJS_CLI_INSTALL and certificate features are under construction._ 170 | 171 | ## Special Volumes 172 | 173 | Docker content is efimerous by design, but in some situations you would like 174 | to keep some stuff **persistent** between docker restarts (ie: database content, 175 | upload files, plugin development...) 176 | 177 | By default we include an structure of directories in the version folders 178 | (see ./volumes), but they are empty and disabled by default in your compose. 179 | To enable them, **you only need to uncomment the volume lines in 180 | your docker-compose.yml** and fill the folders properly. 181 | 182 | When you run the `docker-compose` it will mount the volumes with persistent 183 | data and will let you share files from your host with the container. 184 | 185 | This is the usual volumes you will probably like to map: 186 | 187 | 188 | | Host | Container | Volume | Description | 189 | |:----------------------------------------|:----------:|:--------------------------------------|:-------------------------------| 190 | | ./volumes/public | ojs | /var/www/html/public | All public files | 191 | | ./volumes/private | ojs | /var/www/files | All private files (uploads) | 192 | | ./volumes/config/db.charset.conf | db | /etc/mysql/conf.d/charset.cnf | mariaDB config file | 193 | | ./volumes/config/ojs.config.inc.php | ojs | /var/www/html/config.inc.php | OJS config file | 194 | | ./volumes/config/php.custom.ini | ojs | /usr/local/etc/php/conf.d/custom.ini | PHP custom.init | 195 | | ./volumes/config/apache.htaccess | ojs | /var/www/html/.htaccess | Apache2 htaccess | 196 | | ./volumes/logs/app | ojs | /var/log/apache2 | Apache2 Logs | 197 | | ./volumes/logs/db | db | /var/log/mysql | mariaDB Logs | 198 | | ./volumes/db | db | /var/lib/mysql | mariaDB database content | 199 | | ./volumes/db-import | db | /docker-entrypoint-initdb.d | DB init folder (with SQLs) | 200 | | ./volumes/plugins | ojs | /var/www/html/plugins | Ensure host plugins are sync with the ojs version | 201 | | /etc/localtime | ojs | /etc/localtime | Sync clock with the host one. | 202 | | TBD | ojs | /etc/ssl/apache2/server.pem | SSL **crt** certificate | 203 | | TBD | ojs | /etc/ssl/apache2/server.key | SSL **key** certificate | 204 | 205 | In this image we use "bind volumes" with relative paths because it will 206 | give you a clear view where your data is stored. 207 | 208 | The down sides of those volumes is they can not be "named" and docker will 209 | store them with an absolute path (that it’s annoying to make stuff portable) 210 | but I prefer better control about where data is stored than leave it in docker hands. 211 | 212 | And remember this is just an image, so feel free to modify to fit your needs. 213 | 214 | You can add your own volumes. For instance, make sense for a plugin developer 215 | or a themer to create a volume with his/her work, to keep a persistent copy in 216 | the host of the new plugin or theme (see plugins mapping in former table). 217 | 218 | An alternative way of working for developers is working with his/her own local 219 | Dockerfile that will be build to pull the plugin for his/her own repository... 220 | but this will be significantly slower than the volume method. 221 | 222 | Last but not least, those storage folders need to exist with the right permissions 223 | before you run your `docker compose` command or it will fail. 224 | 225 | To be sure your volumes have the right permissions, you can run those commands: 226 | 227 | ```bash 228 | $ sudo chown 100:101 ./volumes -R 229 | $ sudo chown 999:999 ./volumes/db -R 230 | $ sudo chown 999:999 ./volumes/logs/db -R 231 | ``` 232 | 233 | So, permissions for volumes folders are... all the content will be owned by apache2 234 | user and group (uid 100 and gid 101 inside the container), execpt for db and logs/db 235 | folders that will be owned by mysql user and group (uid and gid 999). 236 | 237 | | **TIP:** | 238 | |:---------------------| 239 | | The mysql/mariadb images include a nice entrypoint that let you run the scripts and sql dumps *if your DB is not yet created*. This feature is great for sites migrations, testing, demos, development dummy data, etc. You only need to include you mysqldump file in your `volumes/db-import` folder, map this folder as volume in your docker-compose.yml and start your container to enjoy the magic. | 240 | 241 | ## Built in scripts 242 | 243 | The Dockerfile includes some scritps at "/usr/local/bin" to facilitate common opperations: 244 | 245 | | Script | Container | Description | 246 | |:---------------------|:----------:|:--------------------------------------------------------------------------------------------------------------| 247 | | ojs-run-scheduled | ojs | Runs "php tools/runScheduledTasks.php". Called by cron every hour. | 248 | | ojs-cli-install | ojs | Uses curl to call the ojs install using pre-defined variables (beta). | 249 | | ojs-pre-start | ojs | Enforces some config variables and generates a self-signed cert based on ServerName. | 250 | | ojs-upgrade | ojs | Runs "php tools/upgrade.php upgrade". (beta: issue when config.inc.php is a volume) | 251 | | ojs-variable | ojs | Replaces the variable value in config.inc.php (ie: ojs-variable variable newValue) | 252 | | ojs-migrate | ojs | Takes a dump.sql, public and private files from "migration" folder and builds and builds a docker site (beta) | 253 | 254 | Most of those scripts are still beta, you be careful when you use them. 255 | 256 | You can call the scripts outside the container as follows: 257 | 258 | ```bash 259 | $ docker exec -it ojs_app_journalname /usr/local/bin/ojs-variable session_check_ip Off 260 | ``` 261 | 262 | ## Upgrading OJS 263 | 264 | Thanks to docker, the ugrade process is easy and straightforward. 265 | 266 | 1. **Stop the stack** with the old OJS version (for instance "pkpofficial/ojs:2_4_8-5"). 267 | ```bash 268 | docker compose stop 269 | ``` 270 | 2. **Set the new version** in docker-compose.yml. 271 | 272 | Replace the old version: ```image: pkpofficial/ojs:2_4_5-2``` 273 | 274 | with the new one: ```image: pkpofficial/ojs:3_2_1-4``` 275 | 276 | 3. **Start the container**. As you changed the version, docker-compose will automatically pull a new image with an updated version of the OJS code that will replace the old one (remember that containers are not persistent). 277 | ```bash 278 | $ docker compose up 279 | ``` 280 | 4. **Run the upgrade script** to upgrade the OJS database and files. Easiest was is connecting to your OJS container with [`docker exec`](https://docs.docker.com/engine/reference/commandline/exec/) and run the `ojs-upgrade` built in script with this single line: 281 | ```bash 282 | $ docker exec -it ojs_app_journalname /usr/local/bin/ojs-upgrade 283 | ``` 284 | | **TIP:** Discover your container name? | 285 | |:---------------------------------------| 286 | | You can see the name of all your containers with `docker ps -a`. The ones related with OJS will be something like `ojs_app_journalname`. | 287 | | Use grep to filter as follows: `$ docker ps -a | grep ojs_app` | 288 | 289 | Before the upgrade you will like to [diff](https://linux.die.net/man/1/diff) your `config.inc.php` with the version of the new OJS version to learn about new configuration variables. Be specially carefully with the charsets. 290 | 291 | | **WARNING:** May I upgrade directly to the last OJS stable version? | 292 | |:----------------------------------------------------------------------------------------------------------------| 293 | | It depends on your initial version. The recommended upgrade route is:
**2.x > 2.4.8-5 > 3.1.2-4 > 3.2.1-4 > 3.3.x-x** | 294 | 295 | 296 | ## Apache2 297 | 298 | As said, right now the only avaliable stack is Apache2, so configuration files 299 | and volumes are thought you will work over an apache. 300 | 301 | If you want to know the fastest method to set your own config jump to the next 302 | section **["Easy way to change config stuff"](#easy-way-to-change-config-stuff)**. 303 | 304 | For those who like to understand what happens behind the courtains, you need to 305 | know that during the image building we ask the Dockerfile to copy the content of 306 | `./templates/webServers/apache/phpVersion/root` folder in the root 307 | of your container. 308 | 309 | It means, if you like to add your specific php settings you can do it 310 | creating a PHP configuration in `./templates/webServers/php{5,7,73}/conf.d/0-ojs.ini` 311 | and build you own image locally. 312 | 313 | There are some optimized variables already, you can check them within each 314 | version directory, e.g. `/root/etc/apache2/conf.d/ojs.conf` with your virtualhost 315 | or `/etc/supervisor.conf`... or, now you know what Dockerfile will do, you 316 | can add your own. 317 | 318 | **Again:** Note that template's /root folder is copied into the Docker image 319 | **at build time** so, if you change it, you must rebuild the image for changes 320 | to take effect. 321 | 322 | ### Easy way to change config stuff 323 | 324 | If you don't want to keep you own local images, you can use the ones we 325 | build in dockerHub and map your config files in your `docker-compose.yml`. 326 | 327 | So if you like to change something in (for instance) your php settings, 328 | you only need to created create a `./volumes/config/php.custom.ini` 329 | outside your container and uncomment the volume in your `docker-compose.yml`. 330 | 331 | Check the volumes section for a list of folders and files we think could 332 | be useful to overwrite or extend to fit your needs. 333 | 334 | ### Restful URLs (aka. clean URLs) 335 | 336 | By default the restful_url are enabled and Apache is already configured, 337 | so there is no need to use index.php over url. 338 | 339 | ### SSL 340 | 341 | By default at the start of Apache one script will check if the SSL certificate 342 | is valid and its CN matches your SERVERNAME, if don't it will generate a new one. 343 | The certificate can be overwritten using a volume mount (see `docker-compose.yml` file). 344 | 345 | _**Note:** This feature is under reveiw and could change in future._ 346 | 347 | ### SSL handled by an external service 348 | 349 | If you have an external service in front handling SSL connections (often referred as 350 | *SSL offloading* or *SSL termination*) you need to add a new line containing 351 | `PassENV HTTPS` in `ojs.conf`, inside the main `` section. 352 | 353 | # How could I help? 354 | 355 | ## Update the compose configurations and Dockerfiles 356 | 357 | If you want to join the docker-ojs (aka. docker4ojs) team you will like to 358 | contribute with new Dockerfiles or docker-composes. To do this, you will need 359 | to clone this project and send us a PR with your contributions. 360 | 361 | Before we follow, let us clarify something: 362 | Versions of this project fit with OJS tag versions, BUT... 363 | if you take a look to PKP's repositories, you will notice the tag naming 364 | syntax changed at version 3.1.2-0. We moved from "ojs-3_1_2-0" to "3_1_2-0". 365 | 366 | So, to avoid keeping in mind at what momment we changed the syntax, in this 367 | project we only use the modern syntax, so you cant/must refer every version 368 | with the same notation. 369 | 370 | Said this, let's talk about how we generate all this versions: 371 | 372 | The files for the different OJS versions and software stacks are generated based 373 | on a number of template files, see directory `templates`. 374 | 375 | You can re-generate all `Dockerfile`, `docker-compose(-local).yml`, configuration 376 | files, etc. calling the `build.sh` script. 377 | 378 | ```bash 379 | # generate a specific version 380 | $ ./build.sh 3_1_2-4 381 | 382 | # generate _all_ versions 383 | $ ./build.sh 384 | ``` 385 | 386 | ## Add a new stack to the list 387 | 388 | Let's say we like us to distribute a "nginx" stack. We have our hands full but 389 | you know docker and nginx so... ¿how could you contribute? 390 | 391 | 1. Be sure the version number is in the versions.list file (ie: 3_2_1-0). 392 | 2. Create the required files and folders in the templates folder. 393 | 394 | Basically you will need: 395 | 396 | - A Dockerfile template for each php version you publish (ie: dockerfile-alpine-nginx-php73.template) 397 | - A generic `docker-compose.yml` template (templates/dockerComposes/docker-compose-nginx.template) 398 | - A folder with all the specific configurations (templates/webServers/nginx/php73/root) 399 | - Extend exclude.list with the stuff you want to be removed. 400 | 401 | This is the hard work. Take apache as a reference and contact us if you need indications. 402 | 403 | 3. Edit build.sh to add your version to the proper variables. 404 | 405 | For the nginx exemple (over alpine) it should be enough extending the webServers array: 406 | ``` 407 | webServers=( 'apache' 'nginx' ) 408 | ``` 409 | Modify the script if you need it to be smarter. 410 | 411 | 4. Run build script to generate all versions again: 412 | 413 | ```bash 414 | $ ./build.sh 415 | ``` 416 | 417 | 5. Test your work running `docker compose` with local dockerfiles. 418 | 419 | 6. Commit a PR with your new build.sh and templates (ignore the versions folder). 420 | 421 | ## Troubleshooting 422 | 423 | #### **I have trouble with Mac** 424 | In general with docker, there are some known issues with the new Mac’s ARM architecture : https://stackoverflow.com/questions/73294020/docker-couldnt-create-the-mpm-accept-mutex . Alternative solution (other than hardcoding mutex settings) might be to build docker image also for arm64 platform (https://github.com/bitnami/containers/issues/4679). Some work was started in this line in gitLab building pipelines with promising preliminary results. 425 | 426 | #### **I have trouble with Windows** 427 | Instructions to run are for linux (as fas as linux is the natural platform for docker and servers) but is also possible to run it in windows. The wget instructions use variables defined in the env-file but this is not compatible with windows powershell, so would be nice to find an alternative that works all platforms. As a temporary solution we add clear instructions for windows users, that need to modify the inliner to get the right version of the config.TEMPLATE file. 428 | 429 | #### **May I get an image based on nginx?** 430 | A nice addition for docker images would be offer nginx image to replace the existing apache2. 431 | 432 | #### **How could I deal with plugins?** 433 | One thing you always will need to deal with is plugins. This is now possible but could be improved with a few ideas that appear during the sprint as: 434 | - Use volumes managed with git 435 | - Create new ojs-plugins script helper that backups and download the essential release plugins for your version. 436 | 437 | #### **Is there any roadmap?** 438 | The project is build based on the needs of the participants. If you like to join, contact marc.bria@uab.cat. 439 | There is no formal roadmap, but we like to implement all the suggestion we made in the [Containers for PKP](https://docs.google.com/document/d/1AoGn1K4ep4vf7ylIS7wU2ybCLHdJNpkDRND7OhfRG-I/edit#heading=h.tpkz1jmp2yzm) document. 440 | Priorities right now are (by order): 441 | 1. Create new images based on "[Containers for PKP](https://docs.google.com/document/d/1AoGn1K4ep4vf7ylIS7wU2ybCLHdJNpkDRND7OhfRG-I/edit#heading=h.tpkz1jmp2yzm)" proposal. 442 | 2. Fixing Mac image issues. 443 | 3. Automatize docker images building and pushing to different repositories. 444 | 445 | #### **When I try to install I got an error...** 446 | > Errors occurred during installation A database error has occurred: SQLSTATE[HY000] [2002] No such file or directory (SQL: create table announcement_types (type_id bigint not null auto_increment primary key, assoc_type smallint not null, assoc_id bigint not null) default character set utf8 collate 'utf8_general_ci') 447 | 448 | When you run the docker-compose.yml, you will be creating different containers with different names. 449 | In this project, the database container will be named as "db" so you can refer it in the "app" container to reach the DB. 450 | So, nevermind if you use the web installer, or you set it manually in the config.inc.php, or you ask the Dockerimage to do it in your behalf... in all cases, you need to be sure you to set "db" when you are asked about the hostname of the database. 451 | 452 | ## License 453 | 454 | GPL3 © [PKP](https://github.com/pkp) 455 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | networks: 2 | inside: 3 | external: false 4 | 5 | services: 6 | db: 7 | image: mariadb:11.4 8 | # env_file: 9 | # - .env 10 | container_name: "ojs_db_${COMPOSE_PROJECT_NAME:-demo}" 11 | environment: 12 | MYSQL_ROOT_PASSWORD: "${MYSQL_ROOT_PASSWORD:-ojsPwd}" 13 | MYSQL_DATABASE: "${OJS_DB_NAME:-ojs}" 14 | MYSQL_USER: "${OJS_DB_USER:-ojs}" 15 | MYSQL_PASSWORD: "${OJS_DB_PASSWORD:-ojsPwd}" 16 | volumes: 17 | - ./volumes/db:/var/lib/mysql 18 | - ./volumes/db-import:/docker-entrypoint-initdb.d 19 | # - ./volumes/logs/db:/var/log/mysql 20 | # - ./volumes/config/db.charset.conf:/etc/mysql/conf.d/charset.cnf 21 | networks: 22 | - inside 23 | restart: unless-stopped 24 | 25 | ojs: 26 | image: "pkpofficial/${OJS_IMAGE:-ojs}:${OJS_VERSION:-latest}" 27 | # env_file: 28 | # - .env 29 | container_name: "ojs_app_${COMPOSE_PROJECT_NAME:-demo}" 30 | hostname: "${COMPOSE_PROJECT_NAME:-demo}" 31 | ports: 32 | - "${HTTP_PORT:-8081}:80" 33 | - "${HTTPS_PORT:-443}:443" 34 | volumes: 35 | - /etc/localtime:/etc/localtime 36 | - ./volumes/private:/var/www/files 37 | - ./volumes/public:/var/www/html/public 38 | # - ./volumes/logs/app:/var/log/apache2 39 | # # WARNING: You can only enable file-volumes if file exists in the container. 40 | - ./volumes/config/ojs.config.inc.php:/var/www/html/config.inc.php 41 | # - ./volumes/config/apache.htaccess:/var/www/html/.htaccess 42 | # - ./volumes/php.custom.ini:/usr/local/etc/php/conf.d/custom.ini 43 | 44 | networks: 45 | - inside 46 | depends_on: 47 | - db 48 | restart: unless-stopped 49 | -------------------------------------------------------------------------------- /volumes/config/README: -------------------------------------------------------------------------------- 1 | Folder to keep your persistent config files 2 | -------------------------------------------------------------------------------- /volumes/db-import/README: -------------------------------------------------------------------------------- 1 | Folder to include your mysqldumps to be imported during container first run. 2 | -------------------------------------------------------------------------------- /volumes/db/README: -------------------------------------------------------------------------------- 1 | Folder to keep your persistent DB files. 2 | --------------------------------------------------------------------------------