mirrors/overleaf-toolkit
1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-11 19:58:18 +02:00
Code Activity

Public release of the Overleaf Toolkit

Browse source
This commit is contained in:
Shane Kilkelly 2020-06-02 14:20:23 +01:00
commit 9395627ac8
39 changed files with 2513 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
.gitignore vendored Normal file
View file

@ -0,0 +1,11 @@
.DS_Store
.idea
*.log
tmp/
*.swp
config/**/*
!config/.gitkeep
data/**/*
!data/.gitkeep

661
LICENSE Normal file
View file

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <http://www.gnu.org/licenses/>.
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
<http://www.gnu.org/licenses/>.

33
README.md Normal file
View file

@ -0,0 +1,33 @@
# Overleaf Toolkit
(Note: this software is currently in beta testing. Functionality and documentation
may be incomplete)
This repository contains the Overleaf Toolkit, the standard tools for running a local
instance of [Overleaf](https://overleaf.com). This toolkit will help you to set up and administer both Overleaf Community Edition (free to use, and community supported), and Overleaf Server Pro (commercial, with professional support).
## Getting Started
Clone this repository locally:
``` sh
git clone https://github.com/overleaf/toolkit.git ./overleaf
```
Then follow the [Quick Start Guide](./doc/quick-start-guide.md).
## Documentation
See [Documentation Index](./doc/README.md)
## Getting Help
Users of the free Community Edition should [open an issue on github](https://github.com/overleaf/toolkit/issues).
Users of Server Pro should contact `support@overleaf.com` for assistance.
In both cases, it is a good idea to include the output of the `bin/doctor` script in your message.

70
bin/backup-config Executable file
View file

@ -0,0 +1,70 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function usage() {
echo "Usage: bin/backup-config [OPTIONS] [DESTINATION]"
echo ""
echo "Backup configuration files, to DESTINATION"
echo ""
echo "Options:"
echo " -m mode: zip | tar | copy (default=copy)"
echo ""
echo "Examples:"
echo ""
echo " bin/backup-config -m zip ~/overleaf-config-backup.zip"
echo ""
echo " bin/backup-config -m tar ~/overleaf-config-backup.tar"
echo ""
echo " bin/backup-config -m copy ~/overleaf-config-backup"
echo ""
echo " bin/backup-config ~/overleaf-config-backup"
echo ""
}
function __main__() {
mode='copy'
while getopts "m:" opt
do
case $opt in
m ) mode="${OPTARG}" ;;
\?) usage && exit ;;
esac
done
shift $(( OPTIND -1 ))
if [[ "${1:-null}" == "null" ]] \
|| [[ "${1:-null}" == "help" ]] \
|| [[ "${1:-null}" == "--help" ]] ; then
usage && exit
fi
destination="$1"
if [[ "$mode" == "copy" ]]; then
cp -r "$TOOLKIT_ROOT/config" "$destination"
elif [[ "$mode" == "zip" ]]; then
zip -j -r "$destination" "$TOOLKIT_ROOT/config"
elif [[ "$mode" == "tar" ]]; then
tar -cf "$destination" -C "$TOOLKIT_ROOT" config
else
echo "Error: unrecognized mode '$mode'"
exit 1
fi
}
__main__ "$@"

3
bin/dev/lint Executable file
View file

@ -0,0 +1,3 @@
#! /usr/bin/env bash
exec find ./bin -type f -not -name '*.swp' -print0 | xargs -0 shellcheck

100
bin/docker-compose Executable file
View file

@ -0,0 +1,100 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
RC_FILE="$TOOLKIT_ROOT/config/overleaf.rc"
function __main__() {
local SHARELATEX_IMAGE_VERSION="$(head -n 1 "$TOOLKIT_ROOT/config/version")"
local MONGO_IMAGE="mongo:3.6"
local REDIS_IMAGE="redis:5.0"
local MONGO_URL="mongodb://mongo/sharelatex"
local REDIS_HOST="redis"
local REDIS_PORT="6379"
if [[ ! "$SHARELATEX_IMAGE_VERSION" \
=~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo "ERROR: invalid version '${SHARELATEX_IMAGE_VERSION}'"
exit 1
fi
# Load vars from the rc file
# shellcheck disable=SC1090
source "$RC_FILE"
# Select which docker-compose files to load
local compose_file_flags=("-f $TOOLKIT_ROOT/lib/docker-compose.base.yml")
if [[ "$REDIS_ENABLED" == "true" ]]; then
compose_file_flags+=("-f $TOOLKIT_ROOT/lib/docker-compose.redis.yml")
fi
if [[ "$MONGO_ENABLED" == "true" ]]; then
compose_file_flags+=("-f $TOOLKIT_ROOT/lib/docker-compose.mongo.yml")
fi
if [[ "$SIBLING_CONTAINERS_ENABLED" == "true" ]]; then
compose_file_flags+=("-f $TOOLKIT_ROOT/lib/docker-compose.sibling-containers.yml")
fi
# Include docker-compose.override.yml if it is present
if [[ -f "$TOOLKIT_ROOT/config/docker-compose.override.yml" ]]; then
compose_file_flags+=("-f $TOOLKIT_ROOT/config/docker-compose.override.yml")
fi
# Build up the flags to pass to docker-compose
local project_name="${PROJECT_NAME:-overleaf}"
local image_name="sharelatex/sharelatex"
if [[ "${SERVER_PRO:-null}" == "true" ]]; then
image_name="quay.io/sharelatex/sharelatex-pro"
fi
local full_image_spec="$image_name:$SHARELATEX_IMAGE_VERSION"
# Canonicalize data paths
SHARELATEX_DATA_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$SHARELATEX_DATA_PATH")
MONGO_DATA_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$MONGO_DATA_PATH")
REDIS_DATA_PATH=$(cd "$TOOLKIT_ROOT"; realpath "$REDIS_DATA_PATH")
# Print debug info
if [[ "${RC_DEBUG:-null}" != "null" ]]; then
echo ">>>>>>VARS>>>>>>"
echo "$(set -o posix; set)" # print all vars
echo "IMAGE_VERSION=$SHARELATEX_IMAGE_VERSION"
echo "<<<<<<<<<<<<<<<<"
echo ">>>>COMPOSE-ARGS>>>>"
echo "-p $project_name"
echo "${compose_file_flags[@]}"
echo "$@"
echo "<<<<<<<<<<<<<<<<<<<<"
fi
# Export vars for use in docker-compose files
export IMAGE="$full_image_spec"
export SHARELATEX_DATA_PATH
export DOCKER_SOCKET_PATH
export MONGO_IMAGE
export MONGO_DATA_PATH
export MONGO_URL
export REDIS_IMAGE
export REDIS_DATA_PATH
export REDIS_HOST
export REDIS_PORT
# shellcheck disable=SC2068
exec docker-compose -p "$project_name" ${compose_file_flags[@]} "$@"
}
__main__ "$@"

231
bin/doctor Executable file
View file

@ -0,0 +1,231 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
SPACES_PER_INDENT=4
WARNINGS_FILE="$(mktemp)"
function add_warning() {
echo "$@" >> "$WARNINGS_FILE"
}
function indent_to_level() {
local levels="$1"
local number_of_spaces=$(( levels * SPACES_PER_INDENT ))
local spaces="$(printf %${number_of_spaces}s)"
echo -n "${spaces}"
}
function print_section_separator() {
echo "====== $* ======"
}
function print_point() {
local indent_level="0"
if [[ "${1:-null}" =~ [0-9]{1} ]]; then
indent_level="$1"
shift
fi
# shellcheck disable=SC2086
echo "$(indent_to_level $indent_level)- $*"
}
function check_host_information() {
print_point 0 "Host Information"
# Linux or not?
if [[ $(uname -a) =~ .*Linux.* ]]; then
print_point 1 "Linux"
else
print_point 1 "Not Linux !"
add_warning "This system seems to not be Linux"
fi
# LSB Information (particular distribution of Linux, and version)
if [[ -n $(command -v lsb_release) ]]; then
print_point 1 "Output of 'lsb_release -a':"
lsb_release -a 2>&1 | while read -r _line; do
echo "$(indent_to_level 3)$_line"
done
else
print_point 1 "lsb_release not found !"
fi
}
function check_dependencies() {
function get_version() {
local binary_name="$1"
if [[ "bash" == "$binary_name" ]]; then
bash -c 'echo $BASH_VERSION'
elif [[ "perl" == "$binary_name" ]]; then
perl -e 'print $];'
else
$binary_name --version | head -n 1
fi
}
function check_for_binary() {
local binary_name="$1"
print_point 1 "$binary_name"
if [[ -n $(command -v "$binary_name") ]]; then
print_point 2 "status: present"
local version=$(get_version "$binary_name")
print_point 2 "version info: $version"
if [[ "$binary_name" == "realpath" ]] \
&& [[ "$(command -V "$binary_name")" =~ .*function.* ]]; then
local message="Could not find 'realpath' binary, falling back to custom function"
print_point 2 "WARNING: $message"
add_warning "$message"
fi
else
print_point 2 "status: MISSING !"
add_warning "$binary_name not found"
fi
}
print_point 0 "Dependencies"
declare -a binaries=(
bash
docker
docker-compose
realpath
perl
awk
)
for binary in "${binaries[@]}"; do
check_for_binary "$binary"
done
}
function check_docker_daemon() {
print_point 0 "Docker Daemon"
if docker ps &>/dev/null; then
print_point 1 "status: up"
else
print_point 1 "status: DOWN !"
add_warning "Docker daemon is not running"
fi
}
function print_warnings() {
print_section_separator "Warnings"
if [[ -n $(head -n 1 "$WARNINGS_FILE") ]]; then
while read -r _line; do
echo "! $_line"
done < "$WARNINGS_FILE"
else
echo "- None, all good"
fi
}
function check_config_files() {
print_section_separator "Configuration"
local config_files=(
"config/version"
"config/overleaf.rc"
"config/variables.env"
)
for config_file in "${config_files[@]}"
do
print_point 0 "$config_file"
if [[ ! -f "$TOOLKIT_ROOT/$config_file" ]]; then
print_point 1 "status: MISSING !"
add_warning "configuration file $config_file not found"
else
print_point 1 "status: present"
if [[ "$config_file" == "config/version" ]]; then
print_point 1 "version: $(head -n 1 "$TOOLKIT_ROOT/$config_file")"
elif [[ "$config_file" == "config/overleaf.rc" ]]; then
print_point 1 "values"
# Load vars from the rc file
# shellcheck disable=SC1090
source "$TOOLKIT_ROOT/$config_file"
# Check some vars from the RC file
if [[ "${SHARELATEX_DATA_PATH:-null}" != "null" ]]; then
print_point 2 "SHARELATEX_DATA_PATH: $SHARELATEX_DATA_PATH"
else
print_point 2 "SHARELATEX_DATA_PATH: MISSING !"
add_warning "rc file, SHARELATEX_DATA_PATH not set"
fi
print_point 2 "SERVER_PRO: $SERVER_PRO"
if [[ "${SERVER_PRO:-null}" == "true" ]]; then
local logged_in
logged_in="$(grep -q quay.io ~/.docker/config.json && echo 'true' || echo 'false')"
print_point 3 "logged in to quay.io: $logged_in"
if [[ "${logged_in}" == "false" ]]; then
local warning_message=(
"Server Pro enabled, but not logged in to quay.io repository."
"These credentials are supplied by Overleaf with a Server Pro"
"license. See https://www.overleaf.com/for/enterprises/features"
"for more details about Server Pro, or contact support@overleaf.com"
"if you have any questions."
)
add_warning "${warning_message[@]}"
fi
print_point 2 "SIBLING_CONTAINERS_ENABLED: $SIBLING_CONTAINERS_ENABLED"
fi
print_point 2 "MONGO_ENABLED: $MONGO_ENABLED"
if [[ "${MONGO_URL:-null}" != "null" ]]; then
print_point 2 "MONGO_URL: [set here]"
fi
if [[ "${MONGO_IMAGE:-null}" != "null" ]]; then
print_point 2 "MONGO_IMAGE: $MONGO_IMAGE"
fi
print_point 2 "REDIS_ENABLED: $REDIS_ENABLED"
if [[ "${REDIS_HOST:-null}" != "null" ]]; then
print_point 2 "REDIS_HOST: [set here]"
fi
if [[ "${REDIS_PORT:-null}" != "null" ]]; then
print_point 2 "REDIS_PORT: [set here]"
fi
if [[ "${REDIS_IMAGE:-null}" != "null" ]]; then
print_point 2 "REDIS_IMAGE: $REDIS_IMAGE"
fi
fi
fi
done
}
function cleanup() {
rm "$WARNINGS_FILE"
}
function __main__() {
print_section_separator "Overleaf Doctor"
check_host_information
check_dependencies
check_docker_daemon
check_config_files
print_warnings
print_section_separator "End"
cleanup
}
__main__ "$@"

51
bin/error-logs Executable file
View file

@ -0,0 +1,51 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function usage() {
echo "Usage: bin/error-logs [OPTIONS] [SERVICES...]"
echo ""
echo "Services: chat, clsi, contacts, docstore, document-updater,"
echo " filestore, notifications, real-time, spelling,"
echo " tags, track-changes, web"
echo ""
echo "Options:"
echo " -f follow log output"
echo " -n {number} number of lines to print (default 20)"
echo ""
echo "Examples:"
echo ""
echo " bin/error-logs -n 50 web clsi"
echo ""
echo " bin/error-logs -f web"
echo ""
echo " bin/error-logs -f web chat docstore"
echo ""
echo " bin/error-logs -n 100 -f filestore "
echo ""
echo " bin/error-logs -f"
}
function __main__() {
if [[ "${1:-null}" == "help" ]] || [[ "${1:-null}" == "--help" ]]; then
usage
exit
fi
# preserve the '==>' labels from tail output
"$TOOLKIT_ROOT/bin/logs" "$@" | grep -E '(^==>.*$|^.*level":50.*$)' --color=never
}
__main__ "$@"

39
bin/images Executable file
View file

@ -0,0 +1,39 @@
#! /usr/bin/env bash
set -uo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function usage() {
echo "Usage: bin/images"
echo ""
echo "Prints information about overleaf docker images on the system"
}
function __main__() {
if [[ "${1:-null}" == "help" ]] \
|| [[ "${1:-null}" == "--help" ]] ; then
usage && exit
fi
echo "---- Community Edition Images ----"
docker images | grep '^sharelatex/sharelatex\s'
echo "---- Server Pro Images ----"
docker images | grep '^quay.io/sharelatex/sharelatex-pro\s'
echo "---- TexLive Images ----"
docker images | grep '^quay.io/sharelatex/texlive'
}
__main__ "$@"

50
bin/init Executable file
View file

@ -0,0 +1,50 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function usage() {
echo "Usage: bin/init"
echo ""
echo "Initialises local configuration files in the 'config/' directory"
echo ""
}
function check_existing_config() {
if [[ -f "$TOOLKIT_ROOT/config/overleaf.rc" ]] \
|| [[ -f "$TOOLKIT_ROOT/config/variables.env" ]] \
|| [[ -f "$TOOLKIT_ROOT/config/version" ]]; then
echo "ERROR: Config files already exist, exiting "
exit 1
fi
}
function set_up_config_files() {
echo "Copying config files to 'config/'"
cp "$TOOLKIT_ROOT/lib/config-seed/overleaf.rc" "$TOOLKIT_ROOT/config/"
cp "$TOOLKIT_ROOT/lib/config-seed/variables.env" "$TOOLKIT_ROOT/config/"
cp "$TOOLKIT_ROOT/lib/config-seed/version" "$TOOLKIT_ROOT/config/"
}
function __main__() {
if [[ "${1:-null}" == "help" ]] || [[ "${1:-null}" == "--help" ]]; then
usage
exit
fi
check_existing_config
set_up_config_files
}
__main__ "$@"

84
bin/logs Executable file
View file

@ -0,0 +1,84 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
DEFAULT_LINES=20
function usage() {
echo "Usage: bin/logs [OPTIONS] [SERVICES...]"
echo ""
echo "Services: chat, clsi, contacts, docstore, document-updater,"
echo " filestore, notifications, real-time, spelling,"
echo " tags, track-changes, web"
echo ""
echo "Options:"
echo " -f follow log output"
echo " -n {number} number of lines to print (default $DEFAULT_LINES)"
echo ""
echo "Examples:"
echo ""
echo " bin/logs -n 50 web clsi"
echo ""
echo " bin/logs -f web"
echo ""
echo " bin/logs -f web chat docstore"
echo ""
echo " bin/logs -n 100 -f filestore "
echo ""
echo " bin/logs -f"
}
function __main__() {
local LINES="$DEFAULT_LINES"
local FOLLOW_FLAG=""
while getopts "fn:" opt
do
case $opt in
f ) FOLLOW_FLAG="-f" ;;
n ) LINES="${OPTARG}" ;;
\?) usage && exit ;;
esac
done
shift $(( OPTIND -1 ))
if [[ "${1:-null}" == "null" ]] \
|| [[ "${1:-null}" == "help" ]] \
|| [[ "${1:-null}" == "--help" ]] ; then
usage && exit
fi
local log_base_path="/var/log/sharelatex"
declare -a services
IFS=" " read -r -a services <<< "$*"
local path_spec="$log_base_path/*.log"
if [[ ! "0" == "${#services[@]}" ]]; then
local log_paths=()
for service in "${services[@]}"; do
log_paths+=("$log_base_path/${service}.log")
done
path_spec="${log_paths[*]}"
fi
local bash_exec_command_string="tail $FOLLOW_FLAG -n $LINES $path_spec"
exec "$TOOLKIT_ROOT/bin/docker-compose" exec sharelatex bash -c "$bash_exec_command_string"
}
__main__ "$@"

22
bin/mongo Executable file
View file

@ -0,0 +1,22 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function __main__() {
exec "$TOOLKIT_ROOT/bin/docker-compose" exec mongo mongo sharelatex
}
__main__ "$@"

22
bin/shell Executable file
View file

@ -0,0 +1,22 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function __main__() {
exec "$TOOLKIT_ROOT/bin/docker-compose" exec sharelatex bash
}
__main__ "$@"

22
bin/start Executable file
View file

@ -0,0 +1,22 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function __main__() {
exec "$TOOLKIT_ROOT/bin/docker-compose" start "$@"
}
__main__ "$@"

22
bin/stop Executable file
View file

@ -0,0 +1,22 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function __main__() {
exec "$TOOLKIT_ROOT/bin/docker-compose" stop "$@"
}
__main__ "$@"

31
bin/up Executable file
View file

@ -0,0 +1,31 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function check_config() {
if [[ ! -f "$TOOLKIT_ROOT/config/overleaf.rc" ]] \
|| [[ ! -f "$TOOLKIT_ROOT/config/variables.env" ]]; then
echo "Config files not found! exiting"
exit 1
fi
}
function __main__() {
check_config
exec "$TOOLKIT_ROOT/bin/docker-compose" up
}
__main__ "$@"

156
bin/upgrade Executable file
View file

@ -0,0 +1,156 @@
#! /usr/bin/env bash
set -euo pipefail
#### Detect Toolkit Project Root ####
# if realpath is not available, create a semi-equivalent function
command -v realpath >/dev/null 2>&1 || realpath() {
[[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
}
SCRIPT_PATH="$(realpath "${BASH_SOURCE[0]}")"
SCRIPT_DIR="$(dirname "$SCRIPT_PATH")"
TOOLKIT_ROOT="$(realpath "$SCRIPT_DIR/..")"
if [[ ! -d "$TOOLKIT_ROOT/bin" ]] || [[ ! -d "$TOOLKIT_ROOT/config" ]]; then
echo "ERROR: could not find root of overleaf-toolkit project (inferred project root as '$TOOLKIT_ROOT')"
exit 1
fi
function usage() {
echo "Usage: bin/upgrade"
echo ""
echo "This script will check for updates to the toolkit code (via git),"
echo "and offer to pull the new changes. It will then check the latest"
echo "available version of the docker image, and offer to update the"
echo "locally configured image (in config/image) if applicable"
echo ""
echo "This script will prompt the user for confirmation at"
echo "each step along the way."
}
function services_up() {
local top_output="$("$TOOLKIT_ROOT/bin/docker-compose" top)"
if [[ -z "$top_output" ]]; then
return 1
else
return 0
fi
}
function git_pull_available() {
local branch="$1"
local fetch_output="$(git -C "$TOOLKIT_ROOT" fetch --dry-run origin "$branch" 2>&1)"
local filtered_fetch_output="$(echo "$fetch_output" | grep '\-> origin/'"$branch")"
if [[ -z "$filtered_fetch_output" ]]; then
return 1
else
return 0
fi
}
function handle_image_upgrade() {
local user_image_version="$(head -n 1 "$TOOLKIT_ROOT/config/version")"
local seed_image_version="$(head -n 1 "$TOOLKIT_ROOT/lib/config-seed/version")"
if [[ ! "$seed_image_version" > "$user_image_version" ]]; then
echo "No change to docker image version"
return 0
fi
echo "New docker image version available ($seed_image_version)"
echo "Current image version is '$user_image_version' (from config/version)"
local should_upgrade="n"
read -r -p "Upgrade image? [y/n] " should_upgrade
if [[ ! "$should_upgrade" =~ [Yy] ]]; then
echo "Keeping image version '$user_image_version'"
return 0
fi
echo "Upgrading config/version from $user_image_version to $seed_image_version"
## Offer to stop docker services
local services_stopped="false"
if services_up; then
echo "docker services are up, stop them first?"
local should_stop="n"
read -r -p "Stop docker services? [y/n] " should_stop
if [[ ! "$should_stop" =~ [Yy] ]]; then
echo "exiting without stopping services"
exit 1
fi
services_stopped="true"
echo "Stopping docker services"
"$TOOLKIT_ROOT/bin/docker-compose" stop
fi
## Advise the user to take a backup
## (NOTE: we can't do this automatically because it will likely require
## sudo privileges. We leave it to the user to sort out for now)
echo "At this point, we recommend backing up your data before proceeding"
echo "!! WARNING: Only do this while the docker services are stopped!!"
local should_proceed="n"
read -r -p "Proceed? [y/n] " should_proceed
if [[ ! "$should_proceed" =~ [Yy] ]]; then
echo "Not proceeding with upgrade"
return 1
fi
## Set the new image version
echo "Backing up old version file to config/__old-version"
cp "$TOOLKIT_ROOT/config/version" "$TOOLKIT_ROOT/config/__old-version"
echo "Over-writing config/version with $seed_image_version"
cp "$TOOLKIT_ROOT/lib/config-seed/version" "$TOOLKIT_ROOT/config/version"
## Maybe offer to start services again
if [[ "${services_stopped:-null}" == "true" ]]; then
local should_start="n"
read -r -p "Start docker services again? [y/n] " should_start
if [[ "$should_start" =~ [Yy] ]]; then
echo "Starting docker services"
"$TOOLKIT_ROOT/bin/docker-compose" up -d
fi
fi
}
function handle_git_update() {
local current_branch
current_branch="$(git -C "$TOOLKIT_ROOT" rev-parse --abbrev-ref HEAD)"
local current_commit
current_commit="$(git -C "$TOOLKIT_ROOT" rev-parse --short HEAD)"
if [[ ! "$current_branch" == "master" ]]; then
echo "Warning: current branch is not master, '$current_branch' instead"
fi
echo "Checking for code update..."
if ! git_pull_available "$current_branch"; then
echo "No code update available"
else
echo "Code update available! (current commit is $current_commit)"
local should_pull="n"
read -r -p "Proceed to pull update? [y/n] " should_pull
if [[ ! "$should_pull" =~ [Yy] ]]; then
echo "Continuing without pulling update"
else
echo "Pulling new code..."
git -C "$TOOLKIT_ROOT" pull origin "$current_branch"
fi
fi
}
function __main__() {
if [[ "${1:-null}" == "help" ]] \
|| [[ "${1:-null}" == "--help" ]] ; then
usage && exit
fi
handle_git_update
handle_image_upgrade
echo "Done"
exit 0
}
__main__ "$@"

0
config/.gitkeep Normal file
View file

0
data/.gitkeep Normal file
View file

41
doc/README.md Normal file
View file

@ -0,0 +1,41 @@
# Documentation
Welcome to the documentation for the Overleaf Toolkit.
This documentation is under construction. You can still find the legacy
documentation on the [Overleaf Wiki](https://github.com/overleaf/overleaf/wiki)
## Getting Started
- [Overview](./overview.md)
- [Quick Start Guide](./quick-start-guide.md)
- [Dependencies](./dependencies.md)
## Using the Toolkit
- [The Doctor](./the-doctor.md)
- [Working with Docker-Compose Services](./docker-compose.md)
## Configuration
- [Configuration Overview](./configuration.md)
- [overleaf.rc](./overleaf-rc.md)
## Persistent Data
- [Persistent Data Overview](./persistent-data.md)
## Server Pro
- [Getting Server Pro](./getting-server-pro.md)
- [Sandboxed Compiles](./sandboxed-compiles.md)
## Upgrades
- [Upgrading the Toolkit](./upgrading.md)

48
doc/configuration.md Normal file
View file

@ -0,0 +1,48 @@
# Configuration Overview
This document describes the configuration files that are used to configure the Overleaf Toolkit.
## Configuration File Location
All user-owned configuration files are found in the `config/` directory.
This directory is excluded from the git revision control system, so it will not be changed by updating the toolkit code. The toolkit will not change any data in the `config/` directory without your permission.
## Initializing the Configuration
Run `bin/init` to initialize a new configuration, with sensible defaults.
This script will not over-write any existing configuration files.
## Backing Up Your Configuration
Use the `bin/backup-config` script to make a backup of your configuration files.
For example:
```sh
bin/backup-config -m zip ~/overleaf-config-backup.zip
```
## The `overleaf.rc` File
The `config/overleaf.rc` file is the most important contains the most important "top level" configuration in the toolkit. It contains statements that set variables, in the format `VARIABLE_NAME=value`.
See [The full specification](./overleaf-rc.md) for more details on the supported options.
## The `variables.env` File
The `config/variables.env` file contains environment variables that are loaded into the overleaf docker container, and used to configure the overleaf microservices. These include the name of the application, as displayed in the header of the web interface, settings for sending emails, and settings for using LDAP with Server Pro.
## The `version` File
The `config/version` file contains the version number of the docker images that will be used to create the running instance of Overleaf.
## The `docker-compose.override.yml` File
If present, the `config/docker-compose.override.yml` file will be included in the invocation to `docker-compose`. This is useful for overriding configuration specific to docker-compose.

16
doc/dependencies.md Normal file
View file

@ -0,0 +1,16 @@
# Dependencies
This project requires a modern unix system as a base (such as Ubuntu Linux).
It also requires `bash`, `docker`, and `docker-compose`.
The `bin/doctor` script can be used to check for missing dependencies.
Note: MacOS does not ship with a `realpath` program. In this case we fall
back to a custom shell function to imitate some of what `realpath` does, but
it is relatively limited. We recommend users on MacOS install the gnu coreutils
with `brew install coreutils`, to get a working version of `realpath`.
## Host Environment
The Overleaf toolkit is tested on Ubuntu Linux, but we expect that most modern Linux systems will be able to run the toolkit without problems. Although it is possible to run the toolkit on other platforms, they are not officially supported.

70
doc/docker-compose.md Normal file
View file

@ -0,0 +1,70 @@
# Working with Docker-Compose Services
The Overleaf toolkit runs Overleaf inside a docker container, plus the
supporting databases (MongoDB and Redis), in their own containers. All of this
is orchestrated with `docker-compose`.
Note: for legacy reasons, the main Overleaf container is called `sharelatex`,
and is based on the `sharelatex/sharelatex` docker image. This is because the
technology is based on the ShareLaTeX code base, which was merged into Overleaf.
See [this blog
post](https://www.overleaf.com/blog/518-exciting-news-sharelatex-is-joining-overleaf)
for more details. At some point in the future, this will be renamed to match the
Overleaf naming scheme.
## The `bin/docker-compose` Wrapper
The `bin/docker-compose` script is a wrapper around `docker-compose`. It
loads configuration from the `config/` directory, before invoking
`docker-compose` with whatever arguments were passed to the script.
You can treat `bin/docker-compose` as a transparent wrapper for the
`docker-compose` program installed on your machine.
For example, we can check which containers are running with the following:
```
$ bin/docker-compose ps
```
## Convenience Helpers
In addition to `bin/docker-compose`, the toolkit also provides a collection of
convenient scripts to automate common tasks:
- `bin/up`: shortcut for `bin/docker-compose up`
- `bin/start`: shortcut for `bin/docker-compose start`
- `bin/stop`: shortcut for `bin/docker-compose stop`
- `bin/shell`: starts a shell inside the main container
## Architecture
Inside the overleaf container, the Overleaf software runs as a set of micro-services, managed by `runit`. Some of the more interesting files inside the container are:
- `/etc/service/`: initialisation files for the microservices
- `/etc/sharelatex/settings.coffee`: unified settings file for the microservices
- `/var/log/sharelatex/`: logs for each microservice
- `/var/www/sharelatex/`: code for the various microservices
- `/var/lib/sharelatex/`: the mount-point for persistent data (corresponds to the directory indicated by `SHARELATEX_DATA_PATH` on the host)
## The MongoDB and Redis Containers
Overleaf dedends on two external databases: MongoDB and Redis. By default, the toolkit will provision a container for each of these databases, in addition to the Overleaf container, for a total of three docker containers.
If you would prefer to connect to an existing MongoDB or Redis instance, you can do so by setting the appropriate settings in the [overleaf.rc](./overleaf-rc.md) configuration file.
## Viewing Individual Micro-Service Logs
The `bin/logs` script allows you to select individual log streams from inside the overleaf container.
For example, if you want to see just the logs for the `web` and `clsi` (compiler) micro-services, run:
```
$ bin/logs -f web clsi
```
See the output of `bin/logs --help` for more options.

35
doc/getting-server-pro.md Normal file
View file

@ -0,0 +1,35 @@
# Getting Server Pro
Overleaf Server Pro is a commercial version of Overleaf, with extra features and commercial support.
See https://www.overleaf.com/for/enterprises/features for more details about Server Pro and how to
buy a license. Or, if you already have a license, contact support@overleaf.com if you need assistance.
## Obtaining Server Pro Image
Server Pro is distributed as a docker image on the [quay.io](https://quay.io) registry: `quay.io/sharelatex/sharelatex-pro`
You will have been supplied with a set of credentials when you signed up for a Server Pro license.
First use your Server Pro credentials to log in to quay.io:
```
docker login quay.io
Username: <sharelatex+your_key_name>
Password: <your key>
```
Then run `bin/docker-compose pull` to pull the image from the `quay.io` registry.
## Switching your installation to Server Pro
We recommend first setting up your toolkit with the default Community Edition image before switching to Server Pro.
You can enable Server Pro by opening `config/overleaf.rc` and changing the `SERVER_PRO` setting to `true`:
```
SERVER_PRO=true
```
The next time you run `bin/up`, the toolkit will use the Server Pro image.

BIN
doc/img/upgrade-demo.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 364 KiB

100
doc/overleaf-rc.md Normal file
View file

@ -0,0 +1,100 @@
# Configuration: `overleaf.rc`
This document describes the variables that are supported in the `config/overleaf.rc` file.
This file consists of variable definitions in the form `NAME=value`. Lines beginning with `#` are treated as comments.
## Variables
### `PROJECT_NAME`
Sets the value of the `--project-name` flag supplied to `docker-compose`.
This is useful when running multiple instances of Overleaf on one host, as each instance can have a different project name.
- Default: overleaf
### `SHARELATEX_DATA_PATH`
Sets the path to the directory that will be mounted into the main `sharelatex` container, and used to store compile data. This can be either a full path (beginning with a `/`), or relative to the base directory of the toolkit.
- Default: data/sharelatex
### `SERVER_PRO`
When set to `true`, tells the toolkit to use the Server Pro image (`quay.io/sharelatex/sharelatex-pro`), rather than the default Community Edition image (`sharelatex/sharelatex`).
- Default: false
### `SIBLING_CONTAINERS_ENABLED`
When set to `true`, tells the toolkit to use the "Sibling Containers" technique
for compiling projects in separate sandboxes, using a separate docker container for
each project. See (the legacy documentation on Sandboxed Compiles)[https://github.com/sharelatex/sharelatex/wiki/Server-Pro:-sandboxed-compiles] for more information.
Requires `SERVER_PRO=true`
- Default: false
### `DOCKER_SOCKET_PATH`
Sets the path to the docker socket on the host machine (the machine running the toolkit code). When `SIBLING_CONTAINERS_ENABLED` is `true`, the socket will be mounted into the container, to allow the compiler service to spawn new docker containers on the host.
Requires `SIBLING_CONTAINERS_ENABLED=true`
- Default: /var/run/docker.sock
### `MONGO_ENABLED`
When set to `true`, tells the toolkit to create a MongoDB container, to host the database.
When set to `false`, this container will not be created, and the system will use the MongoDB database specified by `MONGO_URL` instead.
- Default: true
### `MONGO_URL`
Specifies the MongoDB connection URL to use when `MONGO_ENABLED` is `false`
- Default: not set
### `MONGO_DATA_PATH`
Sets the path to the directory that will be mounted into the `mongo` container, and used to store the MongoDB database. This can be either a full path (beginning with a `/`), or relative to the base directory of the toolkit. This option only affects the local `mongo` container that is created when `MONGO_ENABLED` is `true`.
- Default: data/mongo
### `REDIS_ENABLED`
When set to `true`, tells the toolkit to create a Redis container, to host the redis database.
When set to `false`, this container will not be created, and the system will use the Redis database specified by `REDIS_HOST` and `REDIS_PORT` instead.
- Default: true
### `REDIS_HOST`
Specifies the Redis host to use when `REDIS_ENABLED` is `false`
- Default: not set
### `REDIS_PORT`
Specifies the Redis port to use when `REDIS_ENABLED` is `false`
- Default: not set
### `REDIS_DATA_PATH`
Sets the path to the directory that will be mounted into the `redis` container, and used to store the Redis database. This can be either a full path (beginning with a `/`), or relative to the base directory of the toolkit. This option only affects the local `redis` container that is created when `REDIS_ENABLED` is `true`.
- Default: data/redis

67
doc/overview.md Normal file
View file

@ -0,0 +1,67 @@
# Overleaf Toolkit Overview
## What is Overleaf?
[Overleaf](https://overleaf.com) is an online collaborative writing and publishing tool that makes the whole process of writing, editing and publishing scientific documents much quicker and easier. Overleaf provides the convenience of an easy-to-use LaTeX editor with real-time collaboration and the fully compiled output produced automatically in the background as you type.
## What is the Overleaf Toolkit?
The [Overleaf Toolkit](https://github.com/overleaf/toolkit) is a set of tools that allow anyone to run their own local version of Overleaf. The Overleaf software is distributed in [Docker](https://www.docker.com) images, while the toolkit manages the complexity of making those images run on your computer.
## What are "Community Edition" and "Server Pro"?
Community Edition is the free version of Overleaf, while Server Pro is our enterprise offering, with more features and commercial support. Community Edition is distributed as a docker image on [Docker Hub](https://hub.docker.com/r/sharelatex/sharelatex), whereas Server Pro is distributed as a docker image on a private [quay.io](https://quay.io) registry.
When you set up Overleaf using the toolkit, you will start with Community Edition, and can easily switch to Server Pro by changing just one setting.
## Docker, Docker-Compose, and Overleaf
The toolkit uses [Docker](https://www.docker.com) and [Docker-Compose](https://docs.docker.com/compose/) to run the Overleaf software in an isolated sandbox. While we do recommend becoming familiar with both Docker and Docker-Compose, we also aim to make it as easy as possible to run Overleaf on your own computer.
## How do I get the Toolkit?
The toolkit is distributed as a git repository, here: https://github.com/overleaf/toolkit
If you want to get started right now, we recommend you take a look at the
[Quick-Start Guide](./quick-start-guide.md).
## Toolkit Structure
If you take a look at the toolkit repository, you will see a file structure like this:
```
bin/
config/
data/
doc/
lib/
README.md
```
The `README.md` file contains some important information about the project. The `lib/` directory contains files that are internal to the toolkit, and users should not need to worry about.
### Data Files
By default, the toolkit will put your overleaf data in the `data/` directory. This directory is ignored by git, so you don't need to worry about it being over-written by an update to the toolkit code.
### Configuration Files
Your own configuration files will live in the `config/` directory. This directory is also ignored by git, so it won't be over-written by the toolkit.
### The `bin/` directory
The `bin/` directory contains a collection of scripts, which will be your main interface to the toolkit system. We can start the Overleaf system with `bin/start`, we can check the logs with `bin/logs`, and we can back up our configuration with `bin/backup-config`
### Documentation
You will find all of the documentation you need in the `doc/` directory. This documentation can also be viewed online, here: https://github.com/overleaf/toolkit/tree/master/doc/_index.md

26
doc/persistent-data.md Normal file
View file

@ -0,0 +1,26 @@
# Persistent Data Overview
The Overleaf toolkit needs to store persistent data, such as the files required to compile LaTeX projects, and the contents of the MongoDB database. This is achieved by mounting a few directories from the host machine into the docker containers, and writing the data to those directories.
## Data Directories
The Overleaf contaner requires a directory in which to store data relating to LaTeX compiles. This directory is set with the `SHARELATEX_DATA_PATH` variable in `config/overleaf.rc`.
The MongoDB container, if it is enabled, requires a directory in which to store it's database files, and the same is true of the Redis container. These directories can also be configured in `config/overleaf.rc`.
## File Permissions
Because docker runs as `root`, the data directories will end up being owned by the `root` user, even if the toolkit is being used by a non-root user. This is not a problem, but is worth being aware of, if you intend to alter the persistent data from outside of the containers.
## Backups
The recommended backup procedure is as follows:
- Shut down the docker services with `bin/stop`
- For each of the data directories, make a copy of that directory
to another safe location
- (We recommend using `rsync` for this)
- Start the services again with `bin/start`

174
doc/quick-start-guide.md Normal file
View file

@ -0,0 +1,174 @@
# Quick-Start Guide
## Prerequisites
The overleaf toolkit depends on the following programs:
- bash
- docker
- docker-compose
We recommend that you install the most recent version of docker and docker-compose that
are available on your system.
## Install
First, let's clone this git repository to your machine:
```sh
$ git clone git@github.com:overleaf/toolkit.git ./overleaf
```
Next let's move into this directory:
```sh
$ cd ./overleaf
```
For the rest of this guide, we will assume that you will run all subsequent commands from this directory.
## Take a Look Around
Let's take a look at the structure of the repostory:
```sh
$ ls -l
```
Which will print something like this:
```
bin
config
data
doc
lib
README.md
```
The `README.md` file contains some useful information about the project, while the `doc` directory contains all of the documentation you will need to use the toolkit. The `config` directory will contain your own local configuration files (which we will create in just a moment), while the `bin` directory contains a collection of scripts that manage your overleaf instance.
## Initialise Configuration
Let's create our local configuration, by running `bin/init`:
```sh
$ bin/init
```
Now check the contents of the `config/` directory
```sh
$ ls config
overleaf.rc variables.env version
```
These are the three configuration files you will interact with:
- `overleaf.rc` : the main top-level configuration file
- `variables.env` : environment variables loaded into the docker container
- `version` : the version of the docker images to use
## Starting Up
The overleaf toolkit uses `docker-compose` to manage the overleaf docker containers. The toolkit provides a set of scripts which wrap `docker-compose`, and take care of most of the details for you.
Let's start the docker services:
```sh
$ bin/up
```
You should see some log output from the docker containers, indicating that the containers are running.
If you press `CTRL-C` at the terminal, the services will shut down. You can start them up again (without attaching to the log output) by running `bin/start`. More generally, you can run `bin/docker-compose` to control the `docker-compose` system directly, if you find that the convenience scripts don't cover your use-case.
## Create the first admin account
In a browser, open `http://localhost/launchpad`. You should see a form with email and password fields.
Fill these in with the credentials you want to use as the admin account, then click "Register".
Then click the link to go to the login page (`http://localhost/login`). Enter the credentials.
Once you are logged in, you will be taken to a welcome page.
Click the green button at the bottom of the page to start using Overleaf.
## Create your first project
On the `http://localhost/project` page, you will see a button prompting you to create your first
project. Click the button and follow the instructions.
You should then be taken to the new project, where you will see a text editor and a PDF preview.
## (Optional) Check the logs
Let's look at the logs inside the container:
```sh
$ bin/logs -f web
```
You can also look at the logs for multiple services at once:
```sh
$ bin/logs -f filestore docstore web clsi
```
## Consulting the Doctor
The Overleaf Toolkit comes with a handy tool for debugging your installation: `bin/doctor`
Let's run the `bin/doctor` script:
```sh
$ bin/doctor
```
We should see some output similar to this:
```
====== Overleaf Doctor ======
- Host Information
- Linux
...
- Dependencies
- bash
- status: present
- version info: 5.0.17(1)-release
- docker
- status: present
- version info: Docker version 19.03.6, build 369ce74a3c
- docker-compose
- status: present
- version info: docker-compose version 1.24.0, build 0aa59064
...
====== Configuration ======
...
====== Warnings ======
- None, all good
====== End ======
```
First, we see some information about the host system (the machine that the toolkit is being run on), then some information about dependencies. If any dependencies are missing, we will see a warning here. Next, the doctor checks our local configuration. At the end, the doctor will print out some warnings, if any problems were encountered.
When you run into problems with your toolkit, you should first run the doctor script and check it's output.
## Getting Help
Users of the free Community Edition should [open an issue on github](https://github.com/overleaf/toolkit/issues).
Users of Server Pro should contact `support@overleaf.com` for assistance.
In both cases, it is a good idea to include the output of the `bin/doctor` script in your message.

20
doc/sandboxed-compiles.md Normal file
View file

@ -0,0 +1,20 @@
# Sandboxed Compiles
In Server Pro, it is possible to have each LaTeX project be compiled in a separate docker container, achieving sandbox isolation between projects.
## How It Works
When sandboxed compiles are enabled, the toolkit will mount the docker socket from the host into the overleaf container, so that the compiler service in the container can create new docker containers on the host. Then for each run of the compiler in each project, the LaTeX compiler service (CLSI) will do the following:
- Write out the project files to a location inside the `SHARELATEX_DATA_PATH`,
- Use the mounted docker socket to create a new `texlive` container for the compile run
- Have the `texlive` container read the project data from the location under `SHARELATEX_DATA_PATH`
- Compile the project inside the `texlive` container
## Enabling Sibling Containers
In `config/overleaf.rc`, set `SIBLING_CONTAINERS_ENABLED=true`, and ensure that the `DOCKER_SOCKET_PATH` setting is set to the location of the docker socket on the host.
The next time you start the docker services (with `bin/up`), the overleaf container will verify that it can communicate with docker on the host machine, and will pull the `texlive` image it requires to create the sandboxed compile containers. This process can take several minutes, and compiles will be un-available during this time.

139
doc/the-doctor.md Normal file
View file

@ -0,0 +1,139 @@
# The Doctor
The Overleaf toolkit comes with a handy `doctor` script, to help with debugging. Just run `bin/doctor` and the script will print out information about your host environment, your configuration, and the dependencies the toolkit needs. This output can also help the Overleaf support team to help you figure out what has gone wrong, in the case of a Server Pro installation.
## Getting Help
Users of the free Community Edition should [open an issue on github](https://github.com/overleaf/toolkit/issues).
Users of Server Pro should contact `support@overleaf.com` for assistance.
In both cases, it is a good idea to include the output of the `bin/doctor` script in your message.
## Consulting with the Doctor
Run the doctor script:
```sh
$ bin/doctor
```
You will see some output like this:
```
====== Overleaf Doctor ======
- Host Information
- Linux
- Output of 'lsb_release -a':
No LSB modules are available.
Distributor ID: Ubuntu
Description: Ubuntu 20.04 LTS
Release: 20.04
Codename: focal
- Dependencies
- bash
- status: present
- version info: 5.0.17(1)-release
- docker
- status: present
- version info: Docker version 19.03.6, build 369ce74a3c
- docker-compose
- status: present
- version info: docker-compose version 1.24.0, build 0aa59064
- realpath
- status: present
- version info: realpath (GNU coreutils) 8.30
- perl
- status: present
- version info: 5.030000
- awk
- status: present
- version info: GNU Awk 5.0.1, API: 2.0 (GNU MPFR 4.0.2, GNU MP 6.2.0)
- Docker Daemon
- status: up
====== Configuration ======
- config/version
- status: present
- version: 2.3.1
- config/overleaf.rc
- status: present
- values
- SHARELATEX_DATA_PATH: data/sharelatex
- SERVER_PRO: false
- MONGO_ENABLED: true
- REDIS_ENABLED: true
- config/variables.env
- status: present
====== Warnings ======
- None, all good
====== End ======
```
### Host Information
The `Host Information` section contains information about the machine on which the toolkit is running. This includes information about the type of Linux system being used.
### Dependencies
The `Dependencies` section shows a list of tools which are required for the toolkit to work.
If the tool is present on the system, it will be listed as `status: present`, along with the version of the tool. For example:
```
- docker
- status: present
- version info: Docker version 19.03.6, build 369ce74a3c
```
However, if the tool is missing, it will be listed as `status: MISSING!`, and a warning will be added to the bottom of the `doctor` output. For example:
```
- docker
- status: MISSING!
```
If any of the dependencies are missing, the toolkit will almost certainly not work.
### Configuration
The `Configuration` section contains information about the files in the `config/` directory. In the case of `config/overleaf.rc`, the doctor also prints out some of the more important values from the file. If any of the files are not present, they will be listed as `status: MISSING!`, and a warning will be added to the bottom of the `doctor` output. For example:
```
====== Configuration ======
- config/version
- status: present
- version: 2.3.1
- config/overleaf.rc
- status: present
- values
- SHARELATEX_DATA_PATH: /tmp/sharelatex
- SERVER_PRO: false
- MONGO_ENABLED: false
- REDIS_ENABLED: true
- config/variables.env
- status: MISSING!
```
The above example shows a few problems:
- The `SHARELATEX_DATA_PATH` variable is set to `/tmp/sharelatex`, which is probably not a safe place to put important data
- The `MONGO_ENABLED` variable is set to `false`, so the toolkit will not provision it's own MongoDB database. In this case, we had better be sure to set `MONGO_URL` to point to a MongoDB database managed outside of the toolkit
- the `config/variables.env` file is missing
### Warnings
The `Warnings` section shows a summary of problems discovered by the doctor script. Or, if there are no problems, this section will say so. For example:
```
====== Warnings ======
- configuration file variables.env not found
- rc file, SHARELATEX_DATA_PATH not set
====== End =======
```

18
doc/upgrading.md Normal file
View file

@ -0,0 +1,18 @@
# Upgrading
The Overleaf Toolkit is a git repository, so it's easy to get new toolkit features. Just run `bin/upgrade` and follow the prompts.
It is worth noting that the docker image version (at `config/version`), is managed separately from the toolkit code updates. Updating the toolkit code will not automatically change the version of the docker image that you are running.
## The `bin/upgrade` Script
When you run `bin/upgrade`, the script will check if there is an available update to the toolkit code, and offer to update your toolkit. You can always say no to this upgrade, and nothing will change.
If you do choose to update the toolkit code, the script will then check if the _default_ docker image version has changed, and offer to upgrade your local version file (at `config/version`) to match the new default.
If you do choose to switch versions, the script will then walk you through a process of shutting down the docker services, taking a backup, and restarting the docker services. Your old version file will be automatically copied to `config/__old-version`, just in case you need to roll back to that version of the docker images.
The whole process looks like this:
![Demonstration of the upgrade script](./img/upgrade-demo.gif)

19
lib/config-seed/overleaf.rc Normal file
View file

@ -0,0 +1,19 @@
#### Overleaf RC ####
PROJECT_NAME=overleaf
# Sharelatex container
SHARELATEX_DATA_PATH=data/sharelatex
SERVER_PRO=false
# Sibling Containers
SIBLING_CONTAINERS_ENABLED=false
DOCKER_SOCKET_PATH=/var/run/docker.sock
# Mongo configuration
MONGO_ENABLED=true
MONGO_DATA_PATH=data/mongo
# Redis configuration
REDIS_ENABLED=true
REDIS_DATA_PATH=data/redis

59
lib/config-seed/variables.env Normal file
View file

@ -0,0 +1,59 @@
SHARELATEX_APP_NAME=Overleaf Community Edition XYZ
ENABLED_LINKED_FILE_TYPES=url,project_file
# Enables Thumbnail generation using ImageMagick
ENABLE_CONVERSIONS=true
# Disables email confirmation requirement
EMAIL_CONFIRMATION_DISABLED=true
# temporary fix for LuaLaTex compiles
# see https://github.com/overleaf/overleaf/issues/695
TEXMFVAR=/var/lib/sharelatex/tmp/texmf-var
## Set for SSL via nginx-proxy
#VIRTUAL_HOST=103.112.212.22
# SHARELATEX_SITE_URL=http://sharelatex.mydomain.com
# SHARELATEX_NAV_TITLE=Our ShareLaTeX Instance
# SHARELATEX_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
# SHARELATEX_ADMIN_EMAIL=support@it.com
# SHARELATEX_LEFT_FOOTER=[{"text"="Powered by <a href=\"https://www.sharelatex.com\">ShareLaTeX</a> 2016"},{"text"="Another page I want to link to can be found <a href=\"here\">here</a>"} ]
# SHARELATEX_RIGHT_FOOTER=[{"text"="Hello I am on the Right"} ]
# SHARELATEX_EMAIL_FROM_ADDRESS=team@sharelatex.com
# SHARELATEX_EMAIL_AWS_SES_ACCESS_KEY_ID=
# SHARELATEX_EMAIL_AWS_SES_SECRET_KEY=
# SHARELATEX_EMAIL_SMTP_HOST=smtp.mydomain.com
# SHARELATEX_EMAIL_SMTP_PORT=587
# SHARELATEX_EMAIL_SMTP_SECURE=false
# SHARELATEX_EMAIL_SMTP_USER=
# SHARELATEX_EMAIL_SMTP_PASS=
# SHARELATEX_EMAIL_SMTP_TLS_REJECT_UNAUTH=true
# SHARELATEX_EMAIL_SMTP_IGNORE_TLS=false
# SHARELATEX_CUSTOM_EMAIL_FOOTER=<div>This system is run by department x </div>
################
## Server Pro ##
################
## Works with test LDAP server shown at bottom of docker compose
# SHARELATEX_LDAP_URL=ldap://ldap:389
# SHARELATEX_LDAP_SEARCH_BASE=ou=people,dc=planetexpress,dc=com
# SHARELATEX_LDAP_SEARCH_FILTER=(uid={{username}})
# SHARELATEX_LDAP_BIND_DN=cn=admin,dc=planetexpress,dc=com
# SHARELATEX_LDAP_BIND_CREDENTIALS=GoodNewsEveryone
# SHARELATEX_LDAP_EMAIL_ATT=mail
# SHARELATEX_LDAP_NAME_ATT=cn
# SHARELATEX_LDAP_LAST_NAME_ATT=sn
# SHARELATEX_LDAP_UPDATE_USER_DETAILS_ON_LOGIN=true
# SHARELATEX_TEMPLATES_USER_ID=578773160210479700917ee5
# SHARELATEX_NEW_PROJECT_TEMPLATE_LINKS=[ {"name":"All Templates","url":"/templates/all"}]
# SHARELATEX_PROXY_LEARN="true"

1
lib/config-seed/version Normal file
View file

@ -0,0 +1 @@
2.3.1

17
lib/docker-compose.base.yml Normal file
View file

@ -0,0 +1,17 @@
---
version: '2.2'
services:
sharelatex:
restart: always
image: "${IMAGE}"
container_name: sharelatex
volumes:
- "${SHARELATEX_DATA_PATH}:/var/lib/sharelatex"
ports:
- 80:80
environment:
SHARELATEX_MONGO_URL: "${MONGO_URL}"
SHARELATEX_REDIS_HOST: "${REDIS_HOST}"
REDIS_HOST: "${REDIS_HOST}"
env_file: ../config/variables.env

24
lib/docker-compose.mongo.yml Normal file
View file

@ -0,0 +1,24 @@
---
version: '2.2'
services:
mongo:
restart: always
image: "${MONGO_IMAGE}"
container_name: mongo
volumes:
- "${MONGO_DATA_PATH}:/data/db"
expose:
- 27017
healthcheck:
test: echo 'db.stats().ok' | mongo localhost:27017/test --quiet
interval: 10s
timeout: 10s
retries: 5
sharelatex:
depends_on:
mongo:
condition: service_healthy
links:
- mongo

19
lib/docker-compose.redis.yml Normal file
View file

@ -0,0 +1,19 @@
---
version: '2.2'
services:
redis:
restart: always
image: "${REDIS_IMAGE}"
volumes:
- "${REDIS_DATA_PATH}:/data"
container_name: redis
expose:
- 6379
sharelatex:
depends_on:
redis:
condition: service_started
links:
- redis

12
lib/docker-compose.sibling-containers.yml Normal file
View file

@ -0,0 +1,12 @@
---
version: '2.2'
services:
sharelatex:
volumes:
- "${DOCKER_SOCKET_PATH}:/var/run/docker.sock"
environment:
DOCKER_RUNNER: 'true'
SANDBOXED_COMPILES: 'true'
SANDBOXED_COMPILES_SIBLING_CONTAINERS: 'true'
SANDBOXED_COMPILES_HOST_DIR: "${SHARELATEX_DATA_PATH}/data/compiles"
SYNCTEX_BIN_HOST_PATH: "${SHARELATEX_DATA_PATH}/bin/synctex"