diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 3a375bc..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - -## Steps to Reproduce - - - -1. -2. -3. - -## Expected Behaviour - - -## Observed Behaviour - - - -## Context - - -## Technical Info - - -* URL: -* Browser Name and version: -* Operating System and version (desktop or mobile): -* Signed in as: -* Project and/or file: - -## Analysis - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index f9e3fda..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Description - - - -## Related issues / Pull Requests - - - -## Contributor Agreement - -- [ ] I confirm I have signed the [Contributor License Agreement](https://github.com/overleaf/overleaf/blob/master/CONTRIBUTING.md#contributor-license-agreement) diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 8c5a87b..0000000 --- a/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -# docker image build -.dockerignore - -# user defined files -.env -docker-compose.override.yml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 5217640..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,43 +0,0 @@ -Contributing to Overleaf -========================== - -Thank you for reading this! If you'd like to report a bug or join in the development -of Overleaf, then here are some notes on how to do that. - -Reporting bugs and opening issues ---------------------------------- - -If you'd like to report a bug or open an issue, please **[check if there is an existing issue](https://github.com/overleaf/overleaf/issues).** -If there is then please add any more information that you have, or give it a đź‘Ť. - -When submitting an issue please describe the issue as clearly as possible, including how to -reproduce the bug, which situations it appears in, what you expected to happen, and what actually happens. -If you can include a screenshot for front end issues that is very helpful. - -**Note**: If you are using [www.overleaf.com](www.overleaf.com) and have a problem, or if you would like to request a new feature, please contact the Support team at support@overleaf.com. Raise an issue here only to report bugs in the Community Edition release of Overleaf. - -Pull Requests -------------- - -See [our wiki](https://github.com/overleaf/overleaf/wiki) -for how to manage the Overleaf development environment and for our developer guidelines. - -We love pull requests, so be bold with them! Don't be afraid of going ahead -and changing something, or adding a new feature. We're very happy to work with you -to get your changes merged into Overleaf. - -If you're looking for something to work on, have a look at the [open issues](https://github.com/overleaf/overleaf/issues). - -Security --------- - -Please see [our security policy](https://github.com/overleaf/overleaf/security/policy) if you would like to report a potential security vulnerability. - -Contributor License Agreement ------------------------------ - -Before we can accept any contributions of code, we need you to agree to our -[Contributor License Agreement](https://docs.google.com/forms/d/e/1FAIpQLSef79XH3mb7yIiMzZw-yALEegS-wyFetvjTiNBfZvf_IHD2KA/viewform?usp=sf_link). -This is to ensure that you own the copyright of your contribution, and that you -agree to give us a license to use it in both the open source version, and the version -of Overleaf running at www.overleaf.com, which may have additional changes. diff --git a/LICENSE b/LICENSE deleted file mode 100644 index dba13ed..0000000 --- a/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/README.md b/README.md deleted file mode 100644 index 9018b4d..0000000 --- a/README.md +++ /dev/null @@ -1,1023 +0,0 @@ -

-
- Overleaf -

- -

An open-source online real-time collaborative LaTeX editor.

- -

- Wiki • - Server Pro • - Contributing • - Mailing List • - Authors • - License -

- -A screenshot of a project being edited in Overleaf Extended Community Edition -

- Figure 1: A screenshot of a project being edited in Overleaf Extended Community Edition. -

- -## Community Edition - -[Overleaf](https://www.overleaf.com) is an open-source online real-time collaborative LaTeX editor. Overleaf runs a hosted version at [www.overleaf.com](https://www.overleaf.com), but you can also run your own local version, and contribute to the development of Overleaf. - -## Extended Community Edition - -The present "extended" version of Overleaf CE includes: - -- Template Gallery -- Sandboxed Compiles with TeX Live image selection -- LDAP authentication -- SAML authentication -- OpenID Connect authentication -- Real-time track changes and comments -- Autocomplete of reference keys -- Symbol Palette -- "From External URL" feature - -## Enterprise - -If you want help installing and maintaining Overleaf in your lab or workplace, Overleaf offers an officially supported version called [Overleaf Server Pro](https://www.overleaf.com/for/enterprises). - -## Installation - -Detailed installation instructions can be found in the [Overleaf Toolkit](https://github.com/overleaf/toolkit/). -To run a custom image, add a file named docker-compose.override.yml with the following or similar content into the `overleaf-toolkit/config directory`: - -```yml ---- -services: - sharelatex: - image: sharelatex/sharelatex:ext-ce - volumes: - - ../config/certs:/overleaf/certs -``` -Here, the attached volume provides convenient access for the container to the certificates needed for SAML or LDAP authentication. - -If you want to build a Docker image of the extended CE based on the upstream v5.4.0 codebase, you can check out the corresponding tag by running: -``` -git checkout v5.4.0-ext-v2 -``` -After building the image, switch to the latest state of the repository and check the `server-ce/hotfix` directory. If a subdirectory matching your version (e.g., `5.4.0`) exists, build a patched image. -Alternatively, you can download a prebuilt image from Docker Hub: -``` -docker pull overleafcep/sharelatex:5.4.0-ext-v2 -``` -Make sure to update the image name in overleaf-toolkit/config/docker-compose.override.yml accordingly. - -### New in `v5.4.0-ext-v2`: - -- Added "From External URL" feature -- Introduced Template Gallery -- Improved keyboard input experience in the Symbol Palette -- Fixed compilation error when using the `minted` package - -## Sandboxed Compiles - -To enable sandboxed compiles (also known as "Sibling containers"), set the following configuration options in `overleaf-toolkit/config/overleaf.rc`: - -``` -SERVER_PRO=true -SIBLING_CONTAINERS_ENABLED=true -``` - -The following environment variables are used to specify which TeX Live images to use for sandboxed compiles: - -- `ALL_TEX_LIVE_DOCKER_IMAGES` **(required)** - * A comma-separated list of TeX Live images to use. These images will be downloaded or updated. - To skip downloading the images, set `SIBLING_CONTAINERS_PULL=false` in `config/overleaf.rc`. -- `ALL_TEX_LIVE_DOCKER_IMAGE_NAMES` - * A comma-separated list of friendly names for the images. If omitted, the version name will be used (e.g., `latest-full`). -- `TEX_LIVE_DOCKER_IMAGE` **(required)** - * The default TeX Live image that will be used for compiling new projects. The environment variable `ALL_TEX_LIVE_DOCKER_IMAGES` must include this image. - -Users can select the image for their project in the project menu. - -Here is an example where the default TeX Live image is `latest-full` from Docker Hub, but the `TL2024-historic` image can be used for older projects: -``` -ALL_TEX_LIVE_DOCKER_IMAGES=texlive/texlive:latest-full, texlive/texlive:TL2024-historic -ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=TeXLive 2025, TeXLive 2024 -TEX_LIVE_DOCKER_IMAGE=texlive/texlive:latest-full -``` -For additional details refer to -[Server Pro: Sandboxed Compiles](https://github.com/overleaf/overleaf/wiki/Server-Pro:-Sandboxed-Compiles) and -[Toolkit: Sandboxed Compiles](https://github.com/overleaf/toolkit/blob/master/doc/sandboxed-compiles.md). - -When the compilation takes place in a dedicated container, it is relatively safe to permit running external commands from inside the TeX -file during compilation. This is required for packages like `minted`. For this purpose, the following environment variable can be used: - -- `TEX_COMPILER_EXTRA_FLAGS` - * A list of extra flags for TeX compiler. Example: `-shell-escape -file-line-error` - -
-

Sample variables.env file

 - -``` -OVERLEAF_APP_NAME="Our Overleaf Instance" - -ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url - -# Enables Thumbnail generation using ImageMagick -ENABLE_CONVERSIONS=true - -# Disables email confirmation requirement -EMAIL_CONFIRMATION_DISABLED=true - -## Nginx -# NGINX_WORKER_PROCESSES=4 -# NGINX_WORKER_CONNECTIONS=768 - -## Set for TLS via nginx-proxy -# OVERLEAF_BEHIND_PROXY=true -# OVERLEAF_SECURE_COOKIE=true - -OVERLEAF_SITE_URL=http://my-overleaf-instance.com -OVERLEAF_NAV_TITLE=Our Overleaf Instance -# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png -OVERLEAF_ADMIN_EMAIL=support@example.com - -OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}] -OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}] - -OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com -OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com -OVERLEAF_EMAIL_SMTP_PORT=587 -OVERLEAF_EMAIL_SMTP_SECURE=false -# OVERLEAF_EMAIL_SMTP_USER= -# OVERLEAF_EMAIL_SMTP_PASS= -# OVERLEAF_EMAIL_SMTP_NAME= -OVERLEAF_EMAIL_SMTP_LOGGER=false -OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true -OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false -OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x - -OVERLEAF_PROXY_LEARN=true -NAV_HIDE_POWERED_BY=true - -######################## -## Sandboxed Compiles ## -######################## - -ALL_TEX_LIVE_DOCKER_IMAGES=texlive/texlive:latest-full, texlive/texlive:TL2023-historic -ALL_TEX_LIVE_DOCKER_IMAGE_NAMES=TeXLive 2024, TeXLive 2023 -TEX_LIVE_DOCKER_IMAGE=texlive/texlive:latest-full -TEX_COMPILER_EXTRA_FLAGS=-shell-escape -``` -
- -## "From External URL" feature - -To enable the ["From External URL"](https://www.overleaf.com/learn/how-to/How_to_upload_a_file_using_an_external_URL) feature the variable -`ENABLED_LINKED_FILE_TYPES` must include `url` type: -``` -ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url -``` -This will extend both the *Add Files* menu and the *Insert Figure* dropdown in the toolbar: the *Add Files* menu allows you to add a -file to your project using its URL, while the *Insert Figure* dropdown lets you insert an image into your document directly from its URL. - -## Template Gallery - -The Template Gallery feature is controlled using the following environment variables: - -- `OVERLEAF_TEMPLATE_GALLERY`: Set to `true` to enable the Template Gallery. - -- `OVERLEAF_TEMPLATE_CATEGORIES`: An optional whitespace-separated list of zero or more template category keys. Valid keys include: - _`academic-journal book presentation poster cv homework bibliography calendar formal-letter report thesis newsletter`_ - - The special key `all` is automatically appended. This key represents a category that includes all templates. - - For each category key, the following optional environment variables can be set: - - `TEMPLATE__NAME`: The display name of the template category. - - `TEMPLATE__DESCRIPTION`: A short description of the category. - - If a category key contains a hyphen (`-`), replace it with an underscore (`_`) in the environment variable names. - -- `ENABLE_CONVERSIONS`: Must be set to `true` to enable thumbnail and preview generation for templates. - -- `OVERLEAF_NON_ADMIN_CAN_PUBLISH_TEMPLATES`: Determines whether non-admin users can publish templates. Defaults to `false`. - -To publish a project as a template, select the appropriate option from the project menu. In the form that appears, enter the template details: - - -- The *Title* must be unique. -- The *Description* field supports Markdown formatting. -- The *Author* field accepts Markdown-formatted links. - -After submission, template details can be edited, or the template can be deleted via the Template Gallery page. -Users can manage their own templates; admins can manage any template. - -
-

Example

 - -``` -################# -# TEMPLATES # -################# - -ENABLE_CONVERSIONS=true - -OVERLEAF_TEMPLATE_GALLERY=true -OVERLEAF_NON_ADMIN_CAN_PUBLISH_TEMPLATES=true -OVERLEAF_TEMPLATE_CATEGORIES=academic-journal book presentation poster cv homework bibliography calendar formal-letter report thesis newsletter - -TEMPLATE_ACADEMIC_JOURNAL_NAME=Journal articles -TEMPLATE_ACADEMIC_JOURNAL_DESCRIPTION=Templates for academic journal submissions, including formats for major publishers and preprint servers. - -TEMPLATE_BIBLIOGRAPHY_NAME=Bibliographies -TEMPLATE_BIBLIOGRAPHY_DESCRIPTION=Styles for creating and managing bibliographies with BibTeX or BibLaTeX. Suitable for use in academic papers, theses, and reports. - -TEMPLATE_BOOK_NAME=Books -TEMPLATE_BOOK_DESCRIPTION=Templates for writing books or long-form documents, including chapter structuring, front matter, and indexing. - -TEMPLATE_CALENDAR_NAME=Calendars -TEMPLATE_CALENDAR_DESCRIPTION=Templates to create yearly, monthly, or weekly calendars. Useful for personal planners or event scheduling. - -TEMPLATE_CV_NAME=CVs and résumés -TEMPLATE_CV_DESCRIPTION=Templates for CVs and résumés with various formats for academic, industry, and creative positions. - -TEMPLATE_FORMAL_LETTER_NAME=Formal letters -TEMPLATE_FORMAL_LETTER_DESCRIPTION=Templates for professional letters, such as cover letters, recommendation letters, and official correspondence. - -TEMPLATE_HOMEWORK_NAME=Assignments -TEMPLATE_HOMEWORK_DESCRIPTION=Templates for homework, coursework, and problem sets. Designed to be clean and well-structured for students and educators. - -TEMPLATE_NEWSLETTER_NAME=Newsletters -TEMPLATE_NEWSLETTER_DESCRIPTION=Templates for creating newsletters with formats for academic, corporate, or community communications. - -TEMPLATE_POSTER_NAME=Posters -TEMPLATE_POSTER_DESCRIPTION=Templates for scientific and academic posters, typically used in conferences and research presentations. - -TEMPLATE_PRESENTATION_NAME=Presentations -TEMPLATE_PRESENTATION_DESCRIPTION=Templates for Beamer and other presentation formats, tailored for academic talks and lectures. - -TEMPLATE_REPORT_NAME=Reports -TEMPLATE_REPORT_DESCRIPTION=Templates for technical, lab, or project reports. Includes sections for figures, tables, and references. - -TEMPLATE_THESIS_NAME=Theses -TEMPLATE_THESIS_DESCRIPTION=Templates for writing theses and dissertations, following institutional formatting and citation guidelines. - -TEMPLATE_ALL_NAME=All templates -TEMPLATE_ALL_DESCRIPTION=Browse a collection of all available LaTeX templates, categorized by document type, style, and purpose. - -``` - -
- - -## Authentication Methods - -The following authentication methods are supported: local authentication, LDAP authentication, SAML authentication, -and OpenID Connect (OIDC) authentication. Local authentication is always active. The environment variable `EXTERNAL_AUTH` -specifies which external authentication methods are activated. The value of this variable is a list. If the list includes `ldap`, `saml`, or `oidc`, -then LDAP authentication, SAML authentication, and OIDC authentication will be activated, respectively. - -For example: `EXTERNAL_AUTH=ldap saml oidc` - -This configuration activates all available authentication methods, although this is rarely necessary. - -
-

Local Authentication

 - -Password of local users stored in the MongoDB database. An admin user can create a new local user. For details, visit the -[wiki of Overleaf project](https://github.com/overleaf/overleaf/wiki/Creating-and-managing-users). - -It is possible to enforce password restrictions on local users: - - -* `OVERLEAF_PASSWORD_VALIDATION_MIN_LENGTH`: The minimum length required - -* `OVERLEAF_PASSWORD_VALIDATION_MAX_LENGTH`: The maximum length allowed - -* `OVERLEAF_PASSWORD_VALIDATION_PATTERN`: is used to validate password strength - - - `abc123` – password requires 3 letters and 3 numbers and be at least 6 characters long - - `aA` – password requires lower and uppercase letters and be at least 2 characters long - - `ab$3` – it must contain letters, digits and symbols and be at least 4 characters long - - There are 4 groups of characters: letters, UPPERcase letters, digits, symbols. Anything that is neither a letter nor a digit is considered to be a symbol. - -
- -
-

LDAP Authentication

 - -Internally, Overleaf LDAP uses the [passport-ldapauth](https://github.com/vesse/passport-ldapauth) library. Most of these configuration options are passed through to the `server` config object which is used to configure `passport-ldapauth`. If you are having issues configuring LDAP, it is worth reading the README for `passport-ldapauth` to understand the configuration it expects. - -When using Local and LDAP authentication methods, a user enters a `username` and `password` in the login form. If LDAP authentication is enabled, it is attempted first: - -1. An LDAP user is searched for in the LDAP directory using the filter defined by `OVERLEAF_LDAP_SEARCH_FILTER` and authenticated. -2. If authentication is successful, the Overleaf users database is checked for a user with the primary email address that matches the email address of the authenticated LDAP user: - - If a matching user is found, the `hashedPassword` field for this user is deleted (if it exists). This ensures that the user can only log in via LDAP authentication in the future. - - If no matching user is found, a new Overleaf user is created using the email, first name, and last name retrieved from the LDAP server. -3. If LDAP authentication fails or is unsuccessful, local authentication is attempted. - -#### Environment Variables - -- `OVERLEAF_LDAP_URL` **(required)** - * URL of the LDAP server. - - - Example: `ldaps://ldap.example.com:636` (LDAP over SSL) - - Example: `ldap://ldap.example.com:389` (unencrypted or STARTTLS, if configured). - -- `OVERLEAF_LDAP_EMAIL_ATT` - * The email attribute returned by the LDAP server, default `mail`. Each LDAP user must have at least one email address. - If multiple addresses are provided, only the first one will be used. - -- `OVERLEAF_LDAP_FIRST_NAME_ATT` - * The property name holding the first name of the user which is used in the application, usually `givenName`. - -- `OVERLEAF_LDAP_LAST_NAME_ATT` - * The property name holding the family name of the user which is used in the application, usually `sn`. - -- `OVERLEAF_LDAP_NAME_ATT` - * The property name holding the full name of the user, usually `cn`. If either of the two previous variables is not defined, - the first and/or last name of the user is extracted from this variable. Otherwise, it is not used. - -- `OVERLEAF_LDAP_PLACEHOLDER` - * The placeholder for the login form, defaults to `Username`. - -- `OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN` - * If set to `true`, updates the LDAP user `first_name` and `last_name` field on login, and turn off the user details form on the `/user/settings` - page for LDAP users. Otherwise, details will be fetched only on first login. - -- `OVERLEAF_LDAP_BIND_DN` - * The distinguished name of the LDAP user that should be used for the LDAP connection - (this user should be able to search/list accounts on the LDAP server), - e.g., `cn=ldap_reader,dc=example,dc=com`. If not defined, anonymous binding is used. - -- `OVERLEAF_LDAP_BIND_CREDENTIALS` - * Password for `OVERLEAF_LDAP_BIND_DN`. - -- `OVERLEAF_LDAP_BIND_PROPERTY` - * Property of the user to bind against the client, defaults to `dn`. - -- `OVERLEAF_LDAP_SEARCH_BASE` **(required)** - * The base DN from which to search for users. E.g., `ou=people,dc=example,dc=com`. - -- `OVERLEAF_LDAP_SEARCH_FILTER` - * LDAP search filter with which to find a user. Use the literal '{{username}}' to have the given username be interpolated in for the LDAP search. - - - Example: `(|(uid={{username}})(mail={{username}}))` (user can login with email or with login name). - - Example: `(sAMAccountName={{username}})` (Active Directory). - -- `OVERLEAF_LDAP_SEARCH_SCOPE` - * The scope of the search can be `base`, `one`, or `sub` (default). - -- `OVERLEAF_LDAP_SEARCH_ATTRIBUTES` - * JSON array of attributes to fetch from the LDAP server, e.g., `["uid", "mail", "givenName", "sn"]`. - By default, all attributes are fetched. - -- `OVERLEAF_LDAP_STARTTLS` - * If `true`, LDAP over TLS is used. - -- `OVERLEAF_LDAP_TLS_OPTS_CA_PATH` - * Path to the file containing the CA certificate used to verify the LDAP server's SSL/TLS certificate. If there are multiple certificates, then - it can be a JSON array of paths to the certificates. The files must be accessible to the docker container. - - - Example (one certificate): `/overleaf/certs/ldap_ca_cert.pem` - - Example (multiple certificates): `["/overleaf/certs/ldap_ca_cert1.pem", "/overleaf/certs/ldap_ca_cert2.pem"]` - -- `OVERLEAF_LDAP_TLS_OPTS_REJECT_UNAUTH` - * If `true`, the server certificate is verified against the list of supplied CAs. - -- `OVERLEAF_LDAP_CACHE` - * If `true`, then up to 100 credentials at a time will be cached for 5 minutes. - -- `OVERLEAF_LDAP_TIMEOUT` - * How long the client should let operations live for before timing out, ms (Default: Infinity). - -- `OVERLEAF_LDAP_CONNECT_TIMEOUT` - * How long the client should wait before timing out on TCP connections, ms (Default: OS default). - -- `OVERLEAF_LDAP_IS_ADMIN_ATT` and `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE` - * When both environment variables are set, the login process updates `user.isAdmin = true` if the LDAP profile contains the attribute specified by - `OVERLEAF_LDAP_IS_ADMIN_ATT` and its value either matches `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE` or is an array containing `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE`, - otherwise `user.isAdmin` is set to `false`. If either of these variables is not set, then the admin status is only set to `true` during admin user - creation in Launchpad. - -The following five variables are used to configure how user contacts are retrieved from the LDAP server. - -- `OVERLEAF_LDAP_CONTACTS_FILTER` - * The filter used to search for users in the LDAP server to be loaded into contacts. The placeholder '{{userProperty}}' within the filter is replaced with the value of - the property specified by `OVERLEAF_LDAP_CONTACTS_PROPERTY` from the LDAP user initiating the search. If not defined, no users are retrieved from the LDAP server into contacts. - -- `OVERLEAF_LDAP_CONTACTS_SEARCH_BASE` - * Specifies the base DN from which to start searching for the contacts. Defaults to `OVERLEAF_LDAP_SEARCH_BASE`. - -- `OVERLEAF_LDAP_CONTACTS_SEARCH_SCOPE` - * The scope of the search can be `base`, `one`, or `sub` (default). - -- `OVERLEAF_LDAP_CONTACTS_PROPERTY` - * Specifies the property of the user object that will replace the '{{userProperty}}' placeholder in the `OVERLEAF_LDAP_CONTACTS_FILTER`. - -- `OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE` - * Specifies the value of the `OVERLEAF_LDAP_CONTACTS_PROPERTY` if the search is initiated by a non-LDAP user. If this variable is not defined, the resulting filter - will match nothing. The value `*` can be used as a wildcard. - -
-
Example
 - - OVERLEAF_LDAP_CONTACTS_FILTER=(gidNumber={{userProperty}}) - OVERLEAF_LDAP_CONTACTS_PROPERTY=gidNumber - OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE=1000 - -The above example results in loading into the contacts of the current LDAP user all LDAP users who have the same UNIX `gid`. Non-LDAP users will have all LDAP users with UNIX `gid=1000` in their contacts. - -
- - -
-

Sample variables.env file

 - -``` -OVERLEAF_APP_NAME="Our Overleaf Instance" - -ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url - -# Enables Thumbnail generation using ImageMagick -ENABLE_CONVERSIONS=true - -# Disables email confirmation requirement -EMAIL_CONFIRMATION_DISABLED=true - -## Nginx -# NGINX_WORKER_PROCESSES=4 -# NGINX_WORKER_CONNECTIONS=768 - -## Set for TLS via nginx-proxy -# OVERLEAF_BEHIND_PROXY=true -# OVERLEAF_SECURE_COOKIE=true - -OVERLEAF_SITE_URL=http://my-overleaf-instance.com -OVERLEAF_NAV_TITLE=Our Overleaf Instance -# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png -OVERLEAF_ADMIN_EMAIL=support@example.com - -OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}] -OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}] - -OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com -OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com -OVERLEAF_EMAIL_SMTP_PORT=587 -OVERLEAF_EMAIL_SMTP_SECURE=false -# OVERLEAF_EMAIL_SMTP_USER= -# OVERLEAF_EMAIL_SMTP_PASS= -# OVERLEAF_EMAIL_SMTP_NAME= -OVERLEAF_EMAIL_SMTP_LOGGER=false -OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true -OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false -OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x - -OVERLEAF_PROXY_LEARN=true -NAV_HIDE_POWERED_BY=true - -################# -## LDAP for CE ## -################# - -EXTERNAL_AUTH=ldap -OVERLEAF_LDAP_URL=ldap://ldap.example.com:389 -OVERLEAF_LDAP_STARTTLS=true -OVERLEAF_LDAP_TLS_OPTS_CA_PATH=/overleaf/certs/ldap_ca_cert.pem -OVERLEAF_LDAP_SEARCH_BASE=ou=people,dc=example,dc=com -OVERLEAF_LDAP_SEARCH_FILTER=(|(uid={{username}})(mail={{username}})) -OVERLEAF_LDAP_BIND_DN=cn=ldap_reader,dc=example,dc=com -OVERLEAF_LDAP_BIND_CREDENTIALS=GoodNewsEveryone -OVERLEAF_LDAP_EMAIL_ATT=mail -OVERLEAF_LDAP_FIRST_NAME_ATT=givenName -OVERLEAF_LDAP_LAST_NAME_ATT=sn -# OVERLEAF_LDAP_NAME_ATT=cn -OVERLEAF_LDAP_SEARCH_ATTRIBUTES=["uid", "sn", "givenName", "mail"] - -OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN=true - -OVERLEAF_LDAP_PLACEHOLDER='Username or email address' - -OVERLEAF_LDAP_IS_ADMIN_ATT=mail -OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE=admin@example.com - -OVERLEAF_LDAP_CONTACTS_FILTER=(gidNumber={{userProperty}}) -OVERLEAF_LDAP_CONTACTS_PROPERTY=gidNumber -OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE='*' -``` -
- -
-Deprecated variables - -**These variables will be removed soon**, use `OVERLEAF_LDAP_IS_ADMIN_ATT` and `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE` instead. - -The following variables are used to determine if the user has admin rights. -Please note: the user gains admin status if the search result is not empty, not when the user is explicitly included in the search results. - -- `OVERLEAF_LDAP_ADMIN_SEARCH_BASE` - * Specifies the base DN from which to start searching for the admin group. If this variable is defined, - `OVERLEAF_LDAP_ADMIN_SEARCH_FILTER` must also be defined for the search to function properly. - -- `OVERLEAF_LDAP_ADMIN_SEARCH_FILTER` - * Defines the LDAP search filter used to identify the admin group. The placeholder `{{dn}}` within the filter - is replaced with the value of the property specified by `OVERLEAF_LDAP_ADMIN_DN_PROPERTY`. The placeholder `{{username}}` is also supported. - -- `OVERLEAF_LDAP_ADMIN_DN_PROPERTY` - * Specifies the property of the user object that will replace the '{{dn}}' placeholder - in the `OVERLEAF_LDAP_ADMIN_SEARCH_FILTER`, defaults to `dn`. - -- `OVERLEAF_LDAP_ADMIN_SEARCH_SCOPE` - * The scope of the LDAP search can be `base`, `one`, or `sub` (default) - -
-
Example
 - -In the following example admins are members of a group `admins`, the objectClass of the entry `admins` is `groupOfNames`: - - OVERLEAF_LDAP_ADMIN_SEARCH_BASE='cn=admins,ou=group,dc=example,dc=com' - OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(member={{dn}})' - -In the following example admins are members of a group 'admins', the objectClass of the entry `admins` is `posixGroup`: - - OVERLEAF_LDAP_ADMIN_SEARCH_BASE='cn=admins,ou=group,dc=example,dc=com' - OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(memberUid={{username}})' - -In the following example admins are users with UNIX gid=1234: - - OVERLEAF_LDAP_ADMIN_SEARCH_BASE='ou=people,dc=example,dc=com' - OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(&(gidNumber=1234)(uid={{username}}))' - -In the following example admin is the user with `uid=someuser`: - - OVERLEAF_LDAP_ADMIN_SEARCH_BASE='ou=people,dc=example,dc=com' - OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(&(uid=someuser)(uid={{username}}))' - -The filter - - OVERLEAF_LDAP_ADMIN_SEARCH_FILTER='(uid=someuser)' - -where `someuser` is the uid of an existing user, will always produce a non-empty search result. -As a result, **every user will be granted admin rights**, not just `someuser`, as one might expect. - -
-
-
- -
-

SAML Authentication

 - -Internally, Overleaf SAML module uses the [passport-saml](https://github.com/node-saml/passport-saml) library, most of the following -configuration options are passed through to `passport-saml`. If you are having issues configuring SAML, it is worth reading the README -for `passport-saml` to get a feel for the configuration it expects. - -When using the SAML authentication method, a user is redirected to the Identity Provider (IdP) authentication site. -If the IdP successfully authenticates the user, the Overleaf users database is checked for a record containing a `samlIdentifiers` field structured as follows: - -``` -samlIdentifiers: [ - { - externalUserId: "...", - providerId: "1", - userIdAttribute: "..." - } -] -``` -The `externalUserId` must match the value of the property specified by `userIdAttribute` in the user profile returned by the IdP server. - -If no matching record is found, the database is searched for a user with the primary email address matching the email in the IdP user profile: - -- If such a user is found, the `hashedPassword` field is deleted to disable local authentication, and the `samlIdentifiers` field is added. -- If no matching user is found, a new user is created with the email address and `samlIdentifiers` from the IdP profile. - -**Note:** Currently, only one SAML IdP is supported. The `providerId` field in `samlIdentifiers` is fixed to `'1'`. - -#### Environment Variables - -- `OVERLEAF_SAML_IDENTITY_SERVICE_NAME` - * Display name for the identity service, used on the login page (default: `Log in with SAML IdP`). - -- `OVERLEAF_SAML_USER_ID_FIELD` - * The value of this attribute will be used by Overleaf as the external user ID, defaults to `nameID`. - -- `OVERLEAF_SAML_EMAIL_FIELD` - * Name of the Email field in user profile, defaults to `nameID`. - -- `OVERLEAF_SAML_FIRST_NAME_FIELD` - * Name of the firstName field in user profile, defaults to `givenName`. - -- `OVERLEAF_SAML_LAST_NAME_FIELD` - * Name of the lastName field in user profile, defaults to `lastName` - -- `OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN` - * If set to `true`, updates the user `first_name` and `last_name` field on login, - and turn off the user details form on `/user/settings` page. - -- `OVERLEAF_SAML_ENTRYPOINT` **(required)** - * Entrypoint URL for the SAML identity service. - - - Example: `https://idp.example.com/simplesaml/saml2/idp/SSOService.php` - - Azure Example: `https://login.microsoftonline.com/8b26b46a-6dd3-45c7-a104-f883f4db1f6b/saml2` - -- `OVERLEAF_SAML_ISSUER` **(required)** - * The Issuer name. - -- `OVERLEAF_SAML_AUDIENCE` - * Expected saml response Audience, defaults to value of `OVERLEAF_SAML_ISSUER`. - -- `OVERLEAF_SAML_IDP_CERT` **(required)** - * Path to a file containing the Identity Provider's public certificate, used to validate the signatures of incoming SAML responses. If the Identity Provider has multiple valid signing certificates, then - it can be a JSON array of paths to the certificates. - - - Example (one certificate): `/overleaf/certs/idp_cert.pem` - - Example (multiple certificates): `["/overleaf/certs/idp_cert.pem", "/overleaf/certs/idp_cert_old.pem"]` - -- `OVERLEAF_SAML_PUBLIC_CERT` - * Path to a file containing public signing certificate used to embed in auth requests in order for the IdP to validate the signatures of the incoming SAML Request. It's required when setting up the [metadata endpoint](#metadata-for-the-identity-provider) - when the strategy is configured with a `OVERLEAF_SAML_PRIVATE_KEY`. A JSON array of paths to certificates can be provided to support certificate rotation. When supplying an array of certificates, the first entry in the array should match the - current `OVERLEAF_SAML_PRIVATE_KEY`. Additional entries in the array can be used to publish upcoming certificates to IdPs before changing the `OVERLEAF_SAML_PRIVATE_KEY`. - -- `OVERLEAF_SAML_PRIVATE_KEY` - * Path to a file containing a PEM-formatted private key matching the `OVERLEAF_SAML_PUBLIC_CERT` used to sign auth requests sent by passport-saml. - -- `OVERLEAF_SAML_DECRYPTION_CERT` - * Path to a file containing public certificate, used for the [metadata endpoint](#metadata-for-the-identity-provider). - -- `OVERLEAF_SAML_DECRYPTION_PVK` - * Path to a file containing private key matching the `OVERLEAF_SAML_DECRYPTION_CERT` that will be used to attempt to decrypt any encrypted assertions that are received. - -- `OVERLEAF_SAML_SIGNATURE_ALGORITHM` - * Optionally set the signature algorithm for signing requests, - valid values are 'sha1' (default), 'sha256' (prefered), 'sha512' (most secure, check if your IdP supports it). - -- `OVERLEAF_SAML_ADDITIONAL_PARAMS` - * JSON dictionary of additional query params to add to all requests. - -- `OVERLEAF_SAML_ADDITIONAL_AUTHORIZE_PARAMS` - * JSON dictionary of additional query params to add to 'authorize' requests. - - - Example: `{"some_key": "some_value"}` - -- `OVERLEAF_SAML_IDENTIFIER_FORMAT` - * Name identifier format to request from the identity provider (default: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`). - If using `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`, ensure the `OVERLEAF_SAML_EMAIL_FIELD` envirionment variable is defined. - If `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` is required, you must also define the `OVERLEAF_SAML_ID_FIELD` environment variable, - which can, for example, be set to the user's email address. - -- `OVERLEAF_SAML_ACCEPTED_CLOCK_SKEW_MS` - * Time in milliseconds of skew that is acceptable between client and server when checking OnBefore and NotOnOrAfter assertion - condition validity timestamps. Setting to -1 will disable checking these conditions entirely. Default is 0. - -- `OVERLEAF_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX` - * `AttributeConsumingServiceIndex` attribute to add to AuthnRequest to instruct the IdP which attribute set to attach - to the response ([link](http://blog.aniljohn.com/2014/01/data-minimization-front-channel-saml-attribute-requests.html)). - -- `OVERLEAF_SAML_AUTHN_CONTEXT` - * JSON array of name identifier format values to request auth context. Default: `["urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"]`. - -- `OVERLEAF_SAML_FORCE_AUTHN` - * If `true`, the initial SAML request from the service provider specifies that the IdP should force re-authentication of the user, - even if they possess a valid session. - -- `OVERLEAF_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT` - * If `true`, do not request a specific auth context. For example, you can this this to `true` to allow additional contexts such as password-less logins (`urn:oasis:names:tc:SAML:2.0:ac:classes:X509`). Support for additional contexts is dependant on your IdP. - -- `OVERLEAF_SAML_AUTHN_REQUEST_BINDING` - * If set to `HTTP-POST`, will request authentication from IdP via HTTP POST binding, otherwise defaults to HTTP-Redirect. - -- `OVERLEAF_SAML_VALIDATE_IN_RESPONSE_TO` - * If `always`, then InResponseTo will be validated from incoming SAML responses. - * If `never`, then InResponseTo won't be validated (default). - * If `ifPresent`, then InResponseTo will only be validated if present in the incoming SAML response. - -- `OVERLEAF_SAML_WANT_ASSERTIONS_SIGNED` and `OVERLEAF_SAML_WANT_AUTHN_RESPONSE_SIGNED` - * When set to `true` (default), Overleaf expects the SAML Assertions, respectively the entire SAML Authentication Response, to be signed by the IdP. - When both options are `false`, at least one of the assertions or the response must be signed. - -- `OVERLEAF_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS` - * Defines the expiration time when a Request ID generated for a SAML request will not be valid if seen - in a SAML response in the `InResponseTo` field. Default: 28800000 (8 hours). - -- `OVERLEAF_SAML_LOGOUT_URL` - * base address to call with logout requests (default: `entryPoint`). - - - Example: `https://idp.example.com/simplesaml/saml2/idp/SingleLogoutService.php` - -- `OVERLEAF_SAML_ADDITIONAL_LOGOUT_PARAMS` - * JSON dictionary of additional query params to add to 'logout' requests. - -- `OVERLEAF_SAML_IS_ADMIN_FIELD` and `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE` - * When both environment variables are set, the login process updates `user.isAdmin = true` if the profile returned by the SAML IdP contains the attribute specified by - `OVERLEAF_SAML_IS_ADMIN_FIELD` and its value either matches `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE` or is an array containing `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE`, - otherwise `user.isAdmin` is set to `false`. If either of these variables is not set, then the admin status is only set to `true` during admin user - creation in Launchpad. - -#### Metadata for the Identity Provider - -The current version of Overleaf CE includes and endpoint to retrieve Service Provider Metadata: `http://my-overleaf-instance.com/saml/meta` - -The Identity Provider will need to be configured to recognize the Overleaf server as a "Service Provider". Consult the documentation for your SAML server for instructions on how to do this. - -Below is an example of appropriate Service Provider metadata: - -
-
ol-meta.xml
 - -``` - - - - - - - MII... -[skipped] - - - - - - - - MII... -[skipped] - - - - - - - - - - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress - - - - -``` -
- -Note the certificates, `AssertionConsumerService.Location`, `SingleLogoutService.Location` and `EntityDescriptor.entityID` -and set as appropriate in your IdP configuration, or send the metadata file to the IdP admin. - -
-

Sample variables.env file

 - -``` -OVERLEAF_APP_NAME="Our Overleaf Instance" - -ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url - -# Enables Thumbnail generation using ImageMagick -ENABLE_CONVERSIONS=true - -# Disables email confirmation requirement -EMAIL_CONFIRMATION_DISABLED=true - -## Nginx -# NGINX_WORKER_PROCESSES=4 -# NGINX_WORKER_CONNECTIONS=768 - -## Set for TLS via nginx-proxy -# OVERLEAF_BEHIND_PROXY=true -# OVERLEAF_SECURE_COOKIE=true - -OVERLEAF_SITE_URL=http://my-overleaf-instance.com -OVERLEAF_NAV_TITLE=Our Overleaf Instance -# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png -OVERLEAF_ADMIN_EMAIL=support@example.com - -OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}] -OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}] - -OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com -OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com -OVERLEAF_EMAIL_SMTP_PORT=587 -OVERLEAF_EMAIL_SMTP_SECURE=false -# OVERLEAF_EMAIL_SMTP_USER= -# OVERLEAF_EMAIL_SMTP_PASS= -# OVERLEAF_EMAIL_SMTP_NAME= -OVERLEAF_EMAIL_SMTP_LOGGER=false -OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true -OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false -OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x - -OVERLEAF_PROXY_LEARN=true -NAV_HIDE_POWERED_BY=true - -################# -## SAML for CE ## -################# - -EXTERNAL_AUTH=saml -OVERLEAF_SAML_IDENTITY_SERVICE_NAME='Log in with My IdP' -OVERLEAF_SAML_EMAIL_FIELD=mail -OVERLEAF_SAML_FIRST_NAME_FIELD=givenName -OVERLEAF_SAML_LAST_NAME_FIELD=sn -OVERLEAF_SAML_ENTRYPOINT=https://idp.example.com/simplesamlphp/saml2/idp/SSOService.php -OVERLEAF_SAML_CALLBACK_URL=https://my-overleaf-instance.com/saml/login/callback -OVERLEAF_SAML_LOGOUT_URL=https://idp.example.com/simplesamlphp/saml2/idp/SingleLogoutService.php -OVERLEAF_SAML_LOGOUT_CALLBACK_URL=https://my-overleaf-instance.com/saml/logout/callback -OVERLEAF_SAML_ISSUER=MyOverleaf -OVERLEAF_SAML_IDP_CERT=/overleaf/certs/idp_cert.pem -OVERLEAF_SAML_PUBLIC_CERT=/overleaf/certs/myol_cert.pem -OVERLEAF_SAML_PRIVATE_KEY=/overleaf/certs/myol_key.pem -OVERLEAF_SAML_DECRYPTION_CERT=/overleaf/certs/myol_decr_cert.pem -OVERLEAF_SAML_DECRYPTION_PVK=/overleaf/certs/myol_decr_key.pem -OVERLEAF_SAML_IS_ADMIN_FIELD=mail -OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE=overleaf.admin@example.com -``` -
-
- -
-

OIDC Authentication

 - -Internally, Overleaf OIDC module uses the [passport-openidconnect](https://github.com/jaredhanson/passport-openidconnect) library. -If you are having issues configuring OpenID Connect, it is worth reading the README for `passport-openidconnect` to get a feel for the configuration it expects. - - -When using the OIDC authentication method, a user is redirected to the Identity Provider (IdP) authentication site. -If the IdP successfully authenticates the user, the Overleaf users database is checked for a record containing a `thirdPartyIdentifiers` field structured as follows: - -``` -thirdPartyIdentifiers: [ - { - externalUserId: "...", - externalData: null, - providerId: "..." - } -] -``` - -The `externalUserId` must match the user ID in the profile returned by the IdP server (see the `OVERLEAF_OIDC_USER_ID_FIELD` environment variable), and `providerId` -must match the ID of the OIDC provider (see the `OVERLEAF_OIDC_PROVIDER_ID`). - -If no matching record is found, the database is searched for a user with the primary email address matching the email in the IdP user profile: -- If such a user is found, the `thirdPartyIdentifiers` field is updated. -- If no matching user is found, a new user is created with the email address and `thirdPartyIdentifiers` from the IdP profile. - -In both cases, the user is said to be 'linked' to the external OIDC user. The user can be unlinked from the OIDC provider on the `/user/settings` page. - - -#### Environment Variables - -The values of the following five required variables can be found using `.well-known/openid-configuration` endpoint of your OpenID Provider (OP). - -- `OVERLEAF_OIDC_ISSUER` **(required)** - -- `OVERLEAF_OIDC_AUTHORIZATION_URL` **(required)** - -- `OVERLEAF_OIDC_TOKEN_URL` **(required)** - -- `OVERLEAF_OIDC_USER_INFO_URL` **(required)** - -- `OVERLEAF_OIDC_LOGOUT_URL` **(required)** - -The values of the following two required variables will be provided by the admin of your OP - -- `OVERLEAF_OIDC_CLIENT_ID` **(required)** - -- `OVERLEAF_OIDC_CLIENT_SECRET` **(required)** - -- `OVERLEAF_OIDC_SCOPE` - * Default: `openid profile email` - -- `OVERLEAF_OIDC_PROVIDER_ID` - * Arbitrary ID of the OP, defaults to `oidc`. - -- `OVERLEAF_OIDC_PROVIDER_NAME` - * The name of the OP, used in the `Linked Accounts` section of the `/user/settings` page, defaults to `OIDC Provider`. - -- `OVERLEAF_OIDC_IDENTITY_SERVICE_NAME` - * Display name for the identity service, used on the login page (default: `Log in with $OVERLEAF_OIDC_PROVIDER_NAME`). - -- `OVERLEAF_OIDC_PROVIDER_DESCRIPTION` - * Description of OP, used in the `Linked Accounts` section (default: `Log in with $OVERLEAF_OIDC_PROVIDER_NAME`). - -- `OVERLEAF_OIDC_PROVIDER_INFO_LINK` - * `Learn more` URL in the OP description, default: no `Learn more` link in the description. - -- `OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED` - * Do not show OP on the `/user/settings` page, if the user's account is not linked with the OP, default `false`. - -- `OVERLEAF_OIDC_USER_ID_FIELD` - * The value of this attribute will be used by Overleaf as the external user ID, defaults to `id`. - Other possible reasonable values are `email` and `username` (corresponding to `preferred_username` OIDC claim). - -- `OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN` - * If set to `true`, updates the user `first_name` and `last_name` field on login, - and disables the user details form on `/user/settings` page. - -- `OVERLEAF_OIDC_IS_ADMIN_FIELD` and `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE` - * When both environment variables are set, the login process updates `user.isAdmin = true` if the profile returned by the OP contains the attribute specified by - `OVERLEAF_OIDC_IS_ADMIN_FIELD` and its value matches `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE`, otherwise `user.isAdmin` is set to `false`. - If `OVERLEAF_OIDC_IS_ADMIN_FIELD` is `email` then the value of the attribute `emails[0].value` is used for match checking. - -The redirect URL for your OpenID Provider is `https://my-overleaf-instance.com/oidc/login/callback`. - -
-

Sample variables.env file

 - -``` -OVERLEAF_APP_NAME="Our Overleaf Instance" - -ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url - -# Enables Thumbnail generation using ImageMagick -ENABLE_CONVERSIONS=true - -# Disables email confirmation requirement -EMAIL_CONFIRMATION_DISABLED=true - -## Nginx -# NGINX_WORKER_PROCESSES=4 -# NGINX_WORKER_CONNECTIONS=768 - -## Set for TLS via nginx-proxy -# OVERLEAF_BEHIND_PROXY=true -# OVERLEAF_SECURE_COOKIE=true - -OVERLEAF_SITE_URL=http://my-overleaf-instance.com -OVERLEAF_NAV_TITLE=Our Overleaf Instance -# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png -OVERLEAF_ADMIN_EMAIL=support@example.com - -OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}] -OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "url":"https://github.com/yu-i-i/overleaf-cep"}] - -OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com -OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com -OVERLEAF_EMAIL_SMTP_PORT=587 -OVERLEAF_EMAIL_SMTP_SECURE=false -# OVERLEAF_EMAIL_SMTP_USER= -# OVERLEAF_EMAIL_SMTP_PASS= -# OVERLEAF_EMAIL_SMTP_NAME= -OVERLEAF_EMAIL_SMTP_LOGGER=false -OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true -OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false -OVERLEAF_CUSTOM_EMAIL_FOOTER=This system is run by department x - -OVERLEAF_PROXY_LEARN=true -NAV_HIDE_POWERED_BY=true - -################# -## OIDC for CE ## -################# - -EXTERNAL_AUTH=oidc - -OVERLEAF_OIDC_PROVIDER_ID=oidc -OVERLEAF_OIDC_ISSUER=https://keycloak.provider.com/realms/example -OVERLEAF_OIDC_AUTHORIZATION_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/auth -OVERLEAF_OIDC_TOKEN_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/token -OVERLEAF_OIDC_USER_INFO_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/userinfo -OVERLEAF_OIDC_LOGOUT_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/logout -OVERLEAF_OIDC_CLIENT_ID=Overleaf-OIDC -OVERLEAF_OIDC_CLIENT_SECRET=DoNotUseThisATGgaAcTgCcATgGATTACAagGtTCaGcGTAG -OVERLEAF_OIDC_IDENTITY_SERVICE_NAME='Log in with Keycloak OIDC Provider' -OVERLEAF_OIDC_PROVIDER_NAME=OIDC Keycloak Provider -OVERLEAF_OIDC_PROVIDER_INFO_LINK=https://openid.net -OVERLEAF_OIDC_IS_ADMIN_FIELD=email -OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE=overleaf.admin@example.com -OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN=false -``` -
-
- -## Overleaf Docker Image - -This repo contains two dockerfiles, [`Dockerfile-base`](server-ce/Dockerfile-base), which builds the -`sharelatex/sharelatex-base` image, and [`Dockerfile`](server-ce/Dockerfile) which builds the -`sharelatex/sharelatex` (or "community") image. - -The Base image generally contains the basic dependencies like `wget`, plus `texlive`. -We split this out because it's a pretty heavy set of -dependencies, and it's nice to not have to rebuild all of that every time. - -The `sharelatex/sharelatex` image extends the base image and adds the actual Overleaf code -and services. - -Use `make build-base` and `make build-community` from `server-ce/` to build these images. - -We use the [Phusion base-image](https://github.com/phusion/baseimage-docker) -(which is extended by our `base` image) to provide us with a VM-like container -in which to run the Overleaf services. Baseimage uses the `runit` service -manager to manage services, and we add our init-scripts from the `server-ce/runit` -folder. - -## Authors - -[The Overleaf Team](https://www.overleaf.com/about) -
-Extensions for CE by: [yu-i-i](https://github.com/yu-i-i/overleaf-cep) - -## License - -The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the [`LICENSE`](LICENSE) file. - -Copyright (c) Overleaf, 2014-2025. diff --git a/bin/shared/mongodb-init-replica-set.js b/bin/shared/mongodb-init-replica-set.js deleted file mode 100644 index 30af660..0000000 --- a/bin/shared/mongodb-init-replica-set.js +++ /dev/null @@ -1,3 +0,0 @@ -/* eslint-disable no-undef */ - -rs.initiate({ _id: 'overleaf', members: [{ _id: 0, host: 'mongo:27017' }] }) diff --git a/develop/.gitignore b/develop/.gitignore deleted file mode 100644 index bb5888b..0000000 --- a/develop/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -/compiles/* -!.gitkeep -.env \ No newline at end of file diff --git a/develop/README.md b/develop/README.md deleted file mode 100644 index 14f7354..0000000 --- a/develop/README.md +++ /dev/null @@ -1,90 +0,0 @@ -# Overleaf Community Edition, development environment - -## Building and running - -In this `develop` directory, build the services: - -```shell -bin/build -``` - -> [!NOTE] -> If Docker is running out of RAM while building the services in parallel, create a `.env` file in this directory containing `COMPOSE_PARALLEL_LIMIT=1`. - -Then start the services: - -```shell -bin/up -``` - -Once the services are running, open to create the first admin account. - -## TeX Live - -Compiling a PDF requires building a TeX Live image to handle the compilation inside Docker: - -```shell -docker build texlive -t texlive-full -``` - -> [!NOTE] -> To compile on a macOS host, you may need to override the path to the Docker socket by creating a `.env` file in this directory, containing -> `DOCKER_SOCKET_PATH=/var/run/docker.sock.raw` - -## Development - -To avoid running `bin/build && bin/up` after every code change, you can run Overleaf -Community Edition in _development mode_, where services will automatically update on code changes. - -To do this, use the included `bin/dev` script: - -```shell -bin/dev -``` - -This will start all services using `nodemon`, which will automatically monitor the code and restart the services as necessary. - -To improve performance, you can start only a subset of the services in development mode by providing a space-separated list to the `bin/dev` script: - -```shell -bin/dev [service1] [service2] ... [serviceN] -``` - -> [!NOTE] -> Starting the `web` service in _development mode_ will only update the `web` -> service when backend code changes. In order to automatically update frontend -> code as well, make sure to start the `webpack` service in _development mode_ -> as well. - -If no services are named, all services will start in development mode. - -## Debugging - -When run in _development mode_ most services expose a debugging port to which -you can attach a debugger such as -[the inspector in Chrome's Dev Tools](chrome://inspect/) or one integrated into -an IDE. The following table shows the port exposed on the **host machine** for -each service: - -| Service | Port | -| ------------------ | ---- | -| `web` | 9229 | -| `clsi` | 9230 | -| `chat` | 9231 | -| `contacts` | 9232 | -| `docstore` | 9233 | -| `document-updater` | 9234 | -| `filestore` | 9235 | -| `notifications` | 9236 | -| `real-time` | 9237 | -| `references` | 9238 | -| `history-v1` | 9239 | -| `project-history` | 9240 | - -To attach to a service using Chrome's _remote debugging_, go to - and make sure _Discover network targets_ is checked. Next -click _Configure..._ and add an entry `localhost:[service port]` for each of the -services you want to attach a debugger to. - -After adding an entry, the service will show up as a _Remote Target_ that you -can inspect and debug. diff --git a/develop/bin/build b/develop/bin/build deleted file mode 100755 index bd30abc..0000000 --- a/develop/bin/build +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env bash - -docker compose build --pull "$@" diff --git a/develop/bin/dev b/develop/bin/dev deleted file mode 100755 index 1dca01c..0000000 --- a/develop/bin/dev +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env bash - -docker-compose -f docker-compose.yml -f docker-compose.dev.yml up --no-deps --detach "$@" diff --git a/develop/bin/down b/develop/bin/down deleted file mode 100755 index 3eaad36..0000000 --- a/develop/bin/down +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env bash - -docker compose down "$@" diff --git a/develop/bin/logs b/develop/bin/logs deleted file mode 100755 index 3288ec0..0000000 --- a/develop/bin/logs +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/env bash - -docker compose logs --follow --tail 10 --no-color "$@" \ - | ggrep --line-buffered --invert-match "global.gc" \ - | ggrep --line-buffered --invert-match "health.check" \ - | ggrep --line-buffered --invert-match "slow event loop" \ - | ggrep --line-buffered --invert-match "process.memoryUsage" \ - | ggrep --line-buffered --only-matching "[{].*" \ - | bunyan --output short diff --git a/develop/bin/shell b/develop/bin/shell deleted file mode 100755 index 0929c51..0000000 --- a/develop/bin/shell +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env bash - -docker compose exec -it "$@" /bin/bash diff --git a/develop/bin/up b/develop/bin/up deleted file mode 100755 index b39c4e3..0000000 --- a/develop/bin/up +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env bash - -docker compose up --detach "$@" diff --git a/develop/compiles/.gitkeep b/develop/compiles/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/develop/dev.env b/develop/dev.env deleted file mode 100644 index 2ccfef7..0000000 --- a/develop/dev.env +++ /dev/null @@ -1,21 +0,0 @@ -CHAT_HOST=chat -CLSI_HOST=clsi -CONTACTS_HOST=contacts -DOCSTORE_HOST=docstore -DOCUMENT_UPDATER_HOST=document-updater -FILESTORE_HOST=filestore -GRACEFUL_SHUTDOWN_DELAY_SECONDS=0 -HISTORY_V1_HOST=history-v1 -LISTEN_ADDRESS=0.0.0.0 -MONGO_HOST=mongo -MONGO_URL=mongodb://mongo/sharelatex?directConnection=true -NOTIFICATIONS_HOST=notifications -PROJECT_HISTORY_HOST=project-history -REALTIME_HOST=real-time -REDIS_HOST=redis -REFERENCES_HOST=references -SESSION_SECRET=foo -WEBPACK_HOST=webpack -WEB_API_PASSWORD=overleaf -WEB_API_USER=overleaf -WEB_HOST=web diff --git a/develop/docker-compose.dev.yml b/develop/docker-compose.dev.yml deleted file mode 100644 index 0584413..0000000 --- a/develop/docker-compose.dev.yml +++ /dev/null @@ -1,150 +0,0 @@ -services: - clsi: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9230:9229" - volumes: - - ../services/clsi/app:/overleaf/services/clsi/app - - ../services/clsi/app.js:/overleaf/services/clsi/app.js - - ../services/clsi/config:/overleaf/services/clsi/config - - chat: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9231:9229" - volumes: - - ../services/chat/app:/overleaf/services/chat/app - - ../services/chat/app.js:/overleaf/services/chat/app.js - - ../services/chat/config:/overleaf/services/chat/config - - contacts: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9232:9229" - volumes: - - ../services/contacts/app:/overleaf/services/contacts/app - - ../services/contacts/app.js:/overleaf/services/contacts/app.js - - ../services/contacts/config:/overleaf/services/contacts/config - - docstore: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9233:9229" - volumes: - - ../services/docstore/app:/overleaf/services/docstore/app - - ../services/docstore/app.js:/overleaf/services/docstore/app.js - - ../services/docstore/config:/overleaf/services/docstore/config - - document-updater: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9234:9229" - volumes: - - ../services/document-updater/app:/overleaf/services/document-updater/app - - ../services/document-updater/app.js:/overleaf/services/document-updater/app.js - - ../services/document-updater/config:/overleaf/services/document-updater/config - - filestore: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9235:9229" - volumes: - - ../services/filestore/app:/overleaf/services/filestore/app - - ../services/filestore/app.js:/overleaf/services/filestore/app.js - - ../services/filestore/config:/overleaf/services/filestore/config - - history-v1: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9239:9229" - volumes: - - ../services/history-v1/api:/overleaf/services/history-v1/api - - ../services/history-v1/app.js:/overleaf/services/history-v1/app.js - - ../services/history-v1/config:/overleaf/services/history-v1/config - - ../services/history-v1/storage:/overleaf/services/history-v1/storage - - ../services/history-v1/knexfile.js:/overleaf/services/history-v1/knexfile.js - - ../services/history-v1/migrations:/overleaf/services/history-v1/migrations - - notifications: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9236:9229" - volumes: - - ../services/notifications/app:/overleaf/services/notifications/app - - ../services/notifications/app.js:/overleaf/services/notifications/app.js - - ../services/notifications/config:/overleaf/services/notifications/config - - project-history: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9240:9229" - volumes: - - ../services/project-history/app:/overleaf/services/project-history/app - - ../services/project-history/app.js:/overleaf/services/project-history/app.js - - ../services/project-history/config:/overleaf/services/project-history/config - - real-time: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9237:9229" - volumes: - - ../services/real-time/app:/overleaf/services/real-time/app - - ../services/real-time/app.js:/overleaf/services/real-time/app.js - - ../services/real-time/config:/overleaf/services/real-time/config - - references: - command: ["node", "--watch", "app.js"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9238:9229" - volumes: - - ../services/references/app:/overleaf/services/references/app - - ../services/references/config:/overleaf/services/references/config - - ../services/references/app.js:/overleaf/services/references/app.js - - web: - command: ["node", "--watch", "app.js", "--watch-locales"] - environment: - - NODE_OPTIONS=--inspect=0.0.0.0:9229 - ports: - - "127.0.0.1:9229:9229" - volumes: - - ../services/web/app:/overleaf/services/web/app - - ../services/web/app.mjs:/overleaf/services/web/app.mjs - - ../services/web/config:/overleaf/services/web/config - - ../services/web/locales:/overleaf/services/web/locales - - ../services/web/modules:/overleaf/services/web/modules - - ../services/web/public:/overleaf/services/web/public - - webpack: - volumes: - - ../services/web/app:/overleaf/services/web/app - - ../services/web/config:/overleaf/services/web/config - - ../services/web/frontend:/overleaf/services/web/frontend - - ../services/web/locales:/overleaf/services/web/locales - - ../services/web/modules:/overleaf/services/web/modules - - ../services/web/public:/overleaf/services/web/public - - ../services/web/transform:/overleaf/services/web/transform - - ../services/web/types:/overleaf/services/web/types - - ../services/web/webpack-plugins:/overleaf/services/web/webpack-plugins diff --git a/develop/docker-compose.yml b/develop/docker-compose.yml deleted file mode 100644 index 392cb22..0000000 --- a/develop/docker-compose.yml +++ /dev/null @@ -1,182 +0,0 @@ -volumes: - clsi-cache: - clsi-output: - filestore-public-files: - filestore-template-files: - filestore-uploads: - filestore-user-files: - mongo-data: - redis-data: - sharelatex-data: - web-data: - history-v1-buckets: - -services: - chat: - build: - context: .. - dockerfile: services/chat/Dockerfile - env_file: - - dev.env - - clsi: - build: - context: .. - dockerfile: services/clsi/Dockerfile - env_file: - - dev.env - environment: - - DOCKER_RUNNER=true - - TEXLIVE_IMAGE=texlive-full # docker build texlive -t texlive-full - - COMPILES_HOST_DIR=${PWD}/compiles - user: root - volumes: - - ${PWD}/compiles:/overleaf/services/clsi/compiles - - ${DOCKER_SOCKET_PATH:-/var/run/docker.sock}:/var/run/docker.sock - - clsi-cache:/overleaf/services/clsi/cache - - clsi-output:/overleaf/services/clsi/output - - contacts: - build: - context: .. - dockerfile: services/contacts/Dockerfile - env_file: - - dev.env - - docstore: - build: - context: .. - dockerfile: services/docstore/Dockerfile - env_file: - - dev.env - - document-updater: - build: - context: .. - dockerfile: services/document-updater/Dockerfile - env_file: - - dev.env - - filestore: - build: - context: .. - dockerfile: services/filestore/Dockerfile - env_file: - - dev.env -# environment: -# - ENABLE_CONVERSIONS=true - volumes: - - filestore-public-files:/overleaf/services/filestore/public_files - - filestore-template-files:/overleaf/services/filestore/template_files - - filestore-uploads:/overleaf/services/filestore/uploads - - filestore-user-files:/overleaf/services/filestore/user_files - - history-v1: - build: - context: .. - dockerfile: services/history-v1/Dockerfile - env_file: - - dev.env - environment: - OVERLEAF_EDITOR_ANALYTICS_BUCKET: "/buckets/analytics" - OVERLEAF_EDITOR_BLOBS_BUCKET: "/buckets/blobs" - OVERLEAF_EDITOR_CHUNKS_BUCKET: "/buckets/chunks" - OVERLEAF_EDITOR_PROJECT_BLOBS_BUCKET: "/buckets/project_blobs" - OVERLEAF_EDITOR_ZIPS_BUCKET: "/buckets/zips" - PERSISTOR_BACKEND: fs - volumes: - - history-v1-buckets:/buckets - - mongo: - image: mongo:6.0 - command: --replSet overleaf - ports: - - "127.0.0.1:27017:27017" # for debugging - volumes: - - mongo-data:/data/db - - ../bin/shared/mongodb-init-replica-set.js:/docker-entrypoint-initdb.d/mongodb-init-replica-set.js - environment: - MONGO_INITDB_DATABASE: sharelatex - extra_hosts: - # Required when using the automatic database setup for initializing the - # replica set. This override is not needed when running the setup after - # starting up mongo. - - mongo:127.0.0.1 - - notifications: - build: - context: .. - dockerfile: services/notifications/Dockerfile - env_file: - - dev.env - - project-history: - build: - context: .. - dockerfile: services/project-history/Dockerfile - env_file: - - dev.env - - real-time: - build: - context: .. - dockerfile: services/real-time/Dockerfile - env_file: - - dev.env - - redis: - image: redis:5 - ports: - - "127.0.0.1:6379:6379" # for debugging - volumes: - - redis-data:/data - - references: - build: - context: .. - dockerfile: services/references/Dockerfile - env_file: - - dev.env - - web: - build: - context: .. - dockerfile: services/web/Dockerfile - target: dev - env_file: - - dev.env - environment: - - APP_NAME=Overleaf Community Edition - - ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url - - EMAIL_CONFIRMATION_DISABLED=true - - NODE_ENV=development - - OVERLEAF_ALLOW_PUBLIC_ACCESS=true - command: ["node", "app.mjs"] - volumes: - - sharelatex-data:/var/lib/overleaf - - web-data:/overleaf/services/web/data - depends_on: - - mongo - - redis - - chat - - clsi - - contacts - - docstore - - document-updater - - filestore - - history-v1 - - notifications - - project-history - - real-time - - references - - webpack: - build: - context: .. - dockerfile: services/web/Dockerfile - target: webpack - command: ["npx", "webpack", "serve", "--config", "webpack.config.dev-env.js"] - ports: - - "127.0.0.1:80:3808" - volumes: - - ./webpack.config.dev-env.js:/overleaf/services/web/webpack.config.dev-env.js diff --git a/develop/texlive/Dockerfile b/develop/texlive/Dockerfile deleted file mode 100644 index 944681a..0000000 --- a/develop/texlive/Dockerfile +++ /dev/null @@ -1,8 +0,0 @@ -FROM debian:testing-slim - -RUN apt-get update -RUN apt-cache depends texlive-full | grep "Depends: " | grep -v -- "-doc" | grep -v -- "-lang-" | sed 's/Depends: //' | xargs apt-get install -y --no-install-recommends -RUN apt-get install -y --no-install-recommends fontconfig inkscape pandoc python3-pygments - -RUN useradd tex -USER tex diff --git a/develop/webpack.config.dev-env.js b/develop/webpack.config.dev-env.js deleted file mode 100644 index 49f8540..0000000 --- a/develop/webpack.config.dev-env.js +++ /dev/null @@ -1,23 +0,0 @@ -const { merge } = require('webpack-merge') - -const base = require('./webpack.config.dev') - -module.exports = merge(base, { - devServer: { - allowedHosts: 'auto', - devMiddleware: { - index: false, - }, - proxy: [ - { - context: '/socket.io/**', - target: 'http://real-time:3026', - ws: true, - }, - { - context: ['!**/*.js', '!**/*.css', '!**/*.json'], - target: 'http://web:3000', - }, - ], - }, -}) diff --git a/doc/logo.png b/doc/logo.png deleted file mode 100644 index 106926b..0000000 Binary files a/doc/logo.png and /dev/null differ diff --git a/doc/screenshot.png b/doc/screenshot.png deleted file mode 100644 index 9263319..0000000 Binary files a/doc/screenshot.png and /dev/null differ diff --git a/docker-compose.debug.yml b/docker-compose.debug.yml deleted file mode 100644 index cf87fbf..0000000 --- a/docker-compose.debug.yml +++ /dev/null @@ -1,23 +0,0 @@ -version: '2.2' -services: - sharelatex: - ports: - - 30000:30000 - - 30150:30150 - - 30120:30120 - - 30050:30050 - - 30420:30420 - - 30030:30030 - - 30160:30160 - - 30360:30360 - - 30130:30130 - - 30100:30100 - - 30540:30540 - - 30640:30640 - - 40000:40000 - - # Server Pro - - 30070:30070 - - 30400:30400 - environment: - DEBUG_NODE: 'true' diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index 2beba88..0000000 --- a/docker-compose.yml +++ /dev/null @@ -1,144 +0,0 @@ -version: '2.2' -services: - sharelatex: - restart: always - # Server Pro users: - # image: quay.io/sharelatex/sharelatex-pro - image: sharelatex/sharelatex - container_name: sharelatex - depends_on: - mongo: - condition: service_healthy - redis: - condition: service_started - ports: - - 80:80 - stop_grace_period: 60s - volumes: - - ~/sharelatex_data:/var/lib/overleaf - ######################################################################## - #### Server Pro: Uncomment the following line to mount the docker #### - #### socket, required for Sibling Containers to work #### - ######################################################################## - # - /var/run/docker.sock:/var/run/docker.sock - environment: - - OVERLEAF_APP_NAME: Overleaf Community Edition - - OVERLEAF_MONGO_URL: mongodb://mongo/sharelatex - - # Same property, unfortunately with different names in - # different locations - OVERLEAF_REDIS_HOST: redis - REDIS_HOST: redis - - ENABLED_LINKED_FILE_TYPES: 'project_file,project_output_file,url' - - # Enables Thumbnail generation using ImageMagick - ENABLE_CONVERSIONS: 'true' - - # Disables email confirmation requirement - EMAIL_CONFIRMATION_DISABLED: 'true' - - ## Set for SSL via nginx-proxy - #VIRTUAL_HOST: 103.112.212.22 - - # OVERLEAF_SITE_URL: http://overleaf.example.com - # OVERLEAF_NAV_TITLE: Overleaf Community Edition - # OVERLEAF_HEADER_IMAGE_URL: http://example.com/mylogo.png - # OVERLEAF_ADMIN_EMAIL: support@it.com - - # OVERLEAF_LEFT_FOOTER: '[{"text": "Another page I want to link to can be found here"} ]' - # OVERLEAF_RIGHT_FOOTER: '[{"text": "Hello I am on the Right"} ]' - - # OVERLEAF_EMAIL_FROM_ADDRESS: "hello@example.com" - - # OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID: - # OVERLEAF_EMAIL_AWS_SES_SECRET_KEY: - - # OVERLEAF_EMAIL_SMTP_HOST: smtp.example.com - # OVERLEAF_EMAIL_SMTP_PORT: 587 - # OVERLEAF_EMAIL_SMTP_SECURE: false - # OVERLEAF_EMAIL_SMTP_USER: - # OVERLEAF_EMAIL_SMTP_PASS: - # OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH: true - # OVERLEAF_EMAIL_SMTP_IGNORE_TLS: false - # OVERLEAF_EMAIL_SMTP_NAME: '127.0.0.1' - # OVERLEAF_EMAIL_SMTP_LOGGER: true - # OVERLEAF_CUSTOM_EMAIL_FOOTER: "This system is run by department x" - - # ENABLE_CRON_RESOURCE_DELETION: true - - ################ - ## Server Pro ## - ################ - - ## Sandboxed Compiles: https://github.com/overleaf/overleaf/wiki/Server-Pro:-Sandboxed-Compiles - SANDBOXED_COMPILES: 'true' - SANDBOXED_COMPILES_SIBLING_CONTAINERS: 'true' - ### Bind-mount source for /var/lib/overleaf/data/compiles inside the container. - SANDBOXED_COMPILES_HOST_DIR: '/home/user/sharelatex_data/data/compiles' - - ## Works with test LDAP server shown at bottom of docker compose - # OVERLEAF_LDAP_URL: 'ldap://ldap:389' - # OVERLEAF_LDAP_SEARCH_BASE: 'ou=people,dc=planetexpress,dc=com' - # OVERLEAF_LDAP_SEARCH_FILTER: '(uid={{username}})' - # OVERLEAF_LDAP_BIND_DN: 'cn=admin,dc=planetexpress,dc=com' - # OVERLEAF_LDAP_BIND_CREDENTIALS: 'GoodNewsEveryone' - # OVERLEAF_LDAP_EMAIL_ATT: 'mail' - # OVERLEAF_LDAP_NAME_ATT: 'cn' - # OVERLEAF_LDAP_LAST_NAME_ATT: 'sn' - # OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN: 'true' - - # OVERLEAF_TEMPLATES_USER_ID: "578773160210479700917ee5" - # OVERLEAF_NEW_PROJECT_TEMPLATE_LINKS: '[ {"name":"All Templates","url":"/templates/all"}]' - - - # OVERLEAF_PROXY_LEARN: "true" - - mongo: - restart: always - image: mongo:6.0 - container_name: mongo - command: '--replSet overleaf' - volumes: - - ~/mongo_data:/data/db - - ./bin/shared/mongodb-init-replica-set.js:/docker-entrypoint-initdb.d/mongodb-init-replica-set.js - environment: - MONGO_INITDB_DATABASE: sharelatex - extra_hosts: - # Required when using the automatic database setup for initializing the replica set. - # This override is not needed when running the setup after starting up mongo. - - mongo:127.0.0.1 - healthcheck: - test: echo 'db.stats().ok' | mongosh localhost:27017/test --quiet - interval: 10s - timeout: 10s - retries: 5 - - redis: - restart: always - image: redis:6.2 - container_name: redis - volumes: - - ~/redis_data:/data - - # ldap: - # restart: always - # image: rroemhild/test-openldap - # container_name: ldap - - # See https://github.com/jwilder/nginx-proxy for documentation on how to configure the nginx-proxy container, - # and https://github.com/overleaf/overleaf/wiki/HTTPS-reverse-proxy-using-Nginx for an example of some recommended - # settings. We recommend using a properly managed nginx instance outside of the Overleaf Server Pro setup, - # but the example here can be used if you'd prefer to run everything with docker-compose - - # nginx-proxy: - # image: jwilder/nginx-proxy - # container_name: nginx-proxy - # ports: - # - "80:80" - # - "443:443" - # volumes: - # - /var/run/docker.sock:/tmp/docker.sock:ro - # - /home/overleaf/tmp:/etc/nginx/certs diff --git a/install_unibremen/docker/compose_cep/.env b/install_unibremen/docker/compose_cep/.env new file mode 100644 index 0000000..62c9242 --- /dev/null +++ b/install_unibremen/docker/compose_cep/.env @@ -0,0 +1,23 @@ +# Keycloak OpenID Connect Configuration +OVERLEAF_OIDC_ISSUER=https://sso.fb1.uni-bremen.de/sso/realms/master +OVERLEAF_OIDC_CLIENT_ID=overleaf_test +OVERLEAF_OIDC_CLIENT_SECRET=REDACTED +OVERLEAF_OIDC_IDENTITY_SERVICE_NAME='Log in with SSO FB1 Uni Bremen' + + +# eMail Account Configuration +OVERLEAF_EMAIL_PASSWORD=REDACTED +OVERLEAF_EMAIL_FROM_ADDRESS=overleaf@uni-bremen.de +OVERLEAF_EMAIL_SMTP_HOST=smtp.uni-bremen.de +OVERLEAF_EMAIL_SMTP_PORT=465 +OVERLEAF_EMAIL_SMTP_SECURE=true +OVERLEAF_EMAIL_SMTP_USER=overleaf + +# Other Overleaf Configurations Configuration +OVERLEAF_SITE_URL=https://psintern.neuro.uni-bremen.de +OVERLEAF_ADMIN_EMAIL=overleaf@uni-bremen.de +OVERLEAF_APP_NAME="University of Bremen -- Overleaf" +OVERLEAF_NAV_TITLE="University of Bremen -- Overleaf" +OVERLEAF_CUSTOM_EMAIL_FOOTER="University of Bremen -- Overleaf" + + diff --git a/install_unibremen/docker/compose_cep/overleafserver/compose.yaml b/install_unibremen/docker/compose_cep/overleafserver/compose.yaml index 3aef2e0..cd8b12c 100644 --- a/install_unibremen/docker/compose_cep/overleafserver/compose.yaml +++ b/install_unibremen/docker/compose_cep/overleafserver/compose.yaml @@ -1,6 +1,7 @@ services: overleafserver: - image: sharelatex/sharelatex:5.4.0.2 + image: sharelatex/sharelatex:HEAD +# 5.4.0.2 container_name: overleafserver hostname: overleafserver restart: always diff --git a/install_unibremen/services/web/frontend/js/features/settings/components/account-info-section.tsx b/install_unibremen/services/web/frontend/js/features/settings/components/account-info-section.tsx index c3eee41..d7cdc02 100644 --- a/install_unibremen/services/web/frontend/js/features/settings/components/account-info-section.tsx +++ b/install_unibremen/services/web/frontend/js/features/settings/components/account-info-section.tsx @@ -104,6 +104,24 @@ function AccountInfoSection() { canEdit={canUpdateNames} required={false} /> + {}} + canEdit={false} + required={false} + /> + {}} + canEdit={false} + required={false} + /> {isSuccess ? ( ) : null} - {sshkeys?.Public ? ( - - {"SSH Public Key"} -