mirror of
https://github.com/yu-i-i/overleaf-cep.git
synced 2026-11-12 13:13:45 +01:00
Release v6.2.0-ext-v5.0
yu-i-i
@@ -13,8 +13,12 @@ the following variables has been added in Extended CE:
|
||||
- `OVERLEAF_HISTORY_RESTORE`
|
||||
* If set to `true`, users can restore projects or files from history snapshots. This functionality has existed in CE for a long time and works without visible issues, but it is still considered experimental.
|
||||
To enable restoring from history for projects created before this variable was set to `true`, run the following in `mongosh`:
|
||||
```
|
||||
```javascript
|
||||
db.projects.updateMany({}, { $set: { "overleaf.history.rangesSupportEnabled": true } });
|
||||
```
|
||||
- `OVERLEAF_THEMED_DASHBOARD`
|
||||
* If set to `true`, experimental themed support for project list and admin tools dashboards is enabled.
|
||||
- ~~`OVERLEAF_THEMED_DASHBOARD`~~
|
||||
* ~~If set to `true`, experimental themed support for project list and admin tools dashboards is enabled~~ (removed in `6.2.0-ext-v5.0`)
|
||||
- `ENABLE_EDITOR_TABS`
|
||||
* If set to `true`, enables the experimental upstream editor tabs feature
|
||||
- `ENABLE_PANDOC_CONVERSIONS`
|
||||
* If set to `true`, enables the experimental upstream Pandoc conversion features. See [Pandoc Conversions](Extended-CE:-Pandoc-Conversions) for details
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
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:
|
||||
```
|
||||
```bash
|
||||
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
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
## Git Integration
|
||||
|
||||
The Git integration allows you to clone your Overleaf project into a local Git repository, treating your Overleaf project as a remote repository that you can push to and pull from. For details, refer to the [Overleaf documentation](https://docs.overleaf.com/integrations-and-add-ons/git-integration-and-github-synchronization/git-integration).
|
||||
|
||||
|
||||
If you're using the Toolkit, you can enable the Git integration by setting
|
||||
```bash
|
||||
GIT_BRIDGE_ENABLED=true
|
||||
SERVER_PRO=true
|
||||
```
|
||||
in your `config/overleaf.rc` file. Additionally, update the version number in `overleaf-toolkit/config/version` so that it matches the upstream version.
|
||||
|
||||
If you're using a custom `docker-compose.yml` file, refer to the [Overleaf Server Pro configuration](https://docs.overleaf.com/on-premises/configuration/overleaf-toolkit/server-pro-only-configuration/git-integration).
|
||||
@@ -0,0 +1,100 @@
|
||||
## GitHub Synchronization
|
||||
|
||||
The GitHub synchronization feature allows you to link your Overleaf project to a GitHub repository, which acts as the remote repository for your project and provides a way to synchronize changes between the two.
|
||||
For details, refer to the [Overleaf documentation](https://docs.overleaf.com/integrations-and-add-ons/git-integration-and-github-synchronization/github-synchronization).
|
||||
|
||||
<div align="center">
|
||||
<img src="images/GitHub-Synchronization.png"
|
||||
width="600"
|
||||
>
|
||||
</div>
|
||||
<br>
|
||||
|
||||
Please note that the implementation in CE+ differs from the official Overleaf implementation in several ways:
|
||||
|
||||
- There is no misleading distinction between **Push** and **Pull**, which effectively perform the same operation in the upstream implementation. CE+ provides a single **Sync** operation that performs a two-way merge.
|
||||
- Synchronization is performed on behalf of the user who initiates it, so GitHub correctly attributes the created commits.
|
||||
- Repositories that have been force-pushed are handled more reliably than in the upstream implementation, reducing the need for manual conflict resolution.
|
||||
- A GitHub repository can be unlinked from a project and replaced with a different one.
|
||||
|
||||
To enable GitHub synchronization in CE+, the site administrator must first create a GitHub OAuth application.
|
||||
|
||||
During the application setup, configure the *Authorization callback URL* as follows:
|
||||
|
||||
```text
|
||||
https://your.overleaf.site/user/github-sync/oauth2/callback
|
||||
```
|
||||
|
||||
Replace `https://your.overleaf.site` with the value of `OVERLEAF_SITE_URL`.
|
||||
|
||||
For step-by-step instructions on creating an OAuth application, see the [GitHub documentation](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app).
|
||||
|
||||
After creating the OAuth application, configure the following environment variables:
|
||||
|
||||
```bash
|
||||
GITHUB_SYNC_ENABLED=true
|
||||
GITHUB_SYNC_CLIENT_ID=xxxxxxxxxxxxxxxxxxxx
|
||||
GITHUB_SYNC_CLIENT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
The *Client ID* and *Client Secret* are provided when the OAuth application is created.
|
||||
|
||||
GitHub authorization tokens are stored in MongoDB in encrypted form. By default, a random encryption password is generated on the first startup and stored in the following file:
|
||||
|
||||
```text
|
||||
/var/lib/overleaf/data/.token-cipher.json
|
||||
```
|
||||
|
||||
> **Note:** This file is also used by default to store the encryption password for Zotero authorization tokens.
|
||||
|
||||
Once this file has been created, keep it safe and do not delete it. Otherwise, all users whose authorization tokens were encrypted with the password stored in this file will need to reconnect their GitHub accounts.
|
||||
|
||||
<details>
|
||||
<summary><h4>Technical details</h4></summary>
|
||||
|
||||
If necessary, you can create this file manually. It has the following format:
|
||||
|
||||
```json
|
||||
{
|
||||
"cipherLabel": "OL_CEP-v3",
|
||||
"cipherPasswords": {
|
||||
"OL_CEP-v3": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
||||
"2026.7-v3": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
In most cases, a single password is sufficient.
|
||||
|
||||
The `cipherLabel` field specifies which entry from `cipherPasswords` is used to encrypt newly created tokens. The label format is almost arbitrary: it must not contain a colon (`:`), and it must end with the suffix `-v3`.
|
||||
|
||||
You can change the default location of the file using environment variables:
|
||||
- `GITHUB_TOKEN_CIPHER_FILE` or `TOKEN_CIPHER_FILE`
|
||||
* Specifies the location of the password file. If both are defined, `GITHUB_TOKEN_CIPHER_FILE` takes precedence.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
GITHUB_TOKEN_CIPHER_FILE=/var/lib/overleaf/data/.github-token-cipher.json
|
||||
```
|
||||
|
||||
Alternatively, you can define the encryption password directly using environment variables instead of a file:
|
||||
|
||||
- `GITHUB_TOKEN_CIPHER_PASSWORD` or `TOKEN_CIPHER_PASSWORD`
|
||||
* Specifies the encryption password. If both are defined, `GITHUB_TOKEN_CIPHER_PASSWORD` takes precedence.
|
||||
* **If either of these variables is defined, the password file is ignored.**
|
||||
- `GITHUB_TOKEN_CIPHER_LABEL` or `TOKEN_CIPHER_LABEL`
|
||||
* Specifies the label associated with the encryption password. If both are defined, `GITHUB_TOKEN_CIPHER_LABEL` takes precedence.
|
||||
* Defaults to `OL_CEP-v3`.
|
||||
|
||||
</details>
|
||||
|
||||
At the moment, GitHub synchronization in Overleaf CE+ has the following known limitations:
|
||||
|
||||
- If a repository is very large or contains too many files, operations may fail because of Overleaf restrictions, timeouts or GitHub rate limits ("Too Many Requests"). In such cases, the user receives only a generic server error
|
||||
without any additional explanation.
|
||||
|
||||
- The upstream implementation rejects repositories containing symbolic links. The CE+ implementation allows such repositories to be synchronized. Since Overleaf does not support symbolic links, each symbolic link is imported
|
||||
as a regular file. If that file is later modified in Overleaf and synchronized back to GitHub, the original symbolic link is replaced with a regular file.
|
||||
|
||||
- Files linked into Overleaf from external sources (for example, external URLs or Zotero) become regular read-only files if they are modified in GitHub. This behavior is inherited from the upstream implementation.
|
||||
+11
-10
@@ -1,7 +1,7 @@
|
||||
## 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:
|
||||
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
|
||||
---
|
||||
@@ -11,21 +11,22 @@ services:
|
||||
```
|
||||
If you use the `git-bridge` image, update the version number in `overleaf-toolkit/config/version` to match the upstream version, for example:
|
||||
```
|
||||
6.1.2
|
||||
6.2.0
|
||||
```
|
||||
If you want to build a Docker image of the extended CE based on the upstream `v6.1.0` release, first check out the tag corresponding to `v6.1.0-ext-v4.1`:
|
||||
If you want to build a Docker image of the extended CE based on the upstream `v6.2.0` release, first check out the tag corresponding to `v6.2.0-ext-v5.0`:
|
||||
```
|
||||
git checkout v6.1.0-ext-v4.1
|
||||
git checkout v6.2.0-ext-v5.0
|
||||
```
|
||||
After building this image, switch to the the branch `ext-ce-v6.1`, rewiev the `server-ce/hotfix` directory, and build the patched images sequentially: v6.1.1-ext-v4.1, ..., v6.1.n-ext-v4.1.
|
||||
After building this image, switch to the the branch `ext-ce-v6.2`, rewiev the `server-ce/hotfix` directory, and build the patched images sequentially: v6.2.0-ext-v5.0, ..., v6.2.n-ext-v5.0.
|
||||
|
||||
Alternatively, you can download a prebuilt image from Docker Hub:
|
||||
```
|
||||
docker pull overleafcep/sharelatex:6.2.0-ext-v5.0
|
||||
```
|
||||
Make sure to update the image name in `overleaf-toolkit/config/docker-compose.override.yml` accordingly.
|
||||
|
||||
Notes for updating 5.5.x-ext images:
|
||||
|
||||
- When updating from v5.5.2-ext-v3.2 to v5.5.3-ext-v3.2, remove [this line](https://github.com/yu-i-i/overleaf-cep/blob/1822cfc1b65dfb0ba4392e1ae4764d0999f4ec1f/server-ce/hotfix/5.5.3/Dockerfile#L16) from `server-ce/hotfix/5.5.3/Dockerfile`
|
||||
- v5.5.6-ext-v3.3 should be build on top of v5.5.6-ext-v3.2, using the hotfix directory: `server-ce/hotfix/5.5.6-ext-3.3`
|
||||
|
||||
Alternatively, you can download a prebuilt image from Docker Hub:
|
||||
```
|
||||
docker pull overleafcep/sharelatex:6.1.2-ext-v4.0
|
||||
```
|
||||
Make sure to update the image name in `overleaf-toolkit/config/docker-compose.override.yml` accordingly.
|
||||
|
||||
@@ -134,7 +134,7 @@ The above example results in loading into the contacts of the current LDAP user
|
||||
<details>
|
||||
<summary><h4>Sample variables.env file</h4></summary>
|
||||
|
||||
```
|
||||
```bash
|
||||
OVERLEAF_APP_NAME="Our Overleaf Instance"
|
||||
|
||||
ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
|
||||
|
||||
@@ -102,7 +102,7 @@ The redirect URL for your OpenID Provider is `https://my-overleaf-instance.com/o
|
||||
<details>
|
||||
<summary><h4>Sample variables.env file</h4></summary>
|
||||
|
||||
```
|
||||
```bash
|
||||
OVERLEAF_APP_NAME="Our Overleaf Instance"
|
||||
|
||||
ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
## Pandoc Conversion
|
||||
|
||||
You can import Word documents and Markdown files into Overleaf CE+, and export your project to any of these formats, as well as HTML.
|
||||
For details, refer to the [Overleaf documentation](https://docs.overleaf.com/managing-projects-and-files/importing-and-exporting-files).
|
||||
|
||||
This feature is present in the upstream Overleaf CE, but it is marked as experimental and is not enabled by default.
|
||||
|
||||
To enable it in CE+, define the following environment variables:
|
||||
|
||||
```bash
|
||||
ENABLE_PANDOC_CONVERSIONS=true
|
||||
PANDOC_IMAGE=pandoc-ol:3.10.0.0
|
||||
```
|
||||
|
||||
The second variable specifies the Docker image used for file conversion. Unfortunately, the official Pandoc image from Docker Hub cannot be used directly. Overleaf requires the image to include the `zip` package and to have an empty entrypoint. You therefore need to build a compatible image yourself using the following (or a similar) `Dockerfile`:
|
||||
|
||||
```Dockerfile
|
||||
FROM pandoc/core:3.10.0.0-ubuntu
|
||||
|
||||
ENTRYPOINT []
|
||||
|
||||
RUN apt update \
|
||||
&& apt install -y zip \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
```
|
||||
|
||||
Build the image with:
|
||||
|
||||
```bash
|
||||
docker build -t pandoc-ol:3.10.0.0 .
|
||||
```
|
||||
|
||||
Alternatively, you can download a prebuilt image from Docker Hub:
|
||||
|
||||
```bash
|
||||
docker pull overleafcep/pandoc-ol:3.10.0.0
|
||||
```
|
||||
|
||||
You can also install `pandoc` and `zip` into any Docker image that you use for LaTeX compilation and use that image for Pandoc conversion.
|
||||
|
||||
If you do not use Sandboxed Compiles, simply install the `pandoc` and `zip` packages in your `sharelatex` image.
|
||||
@@ -0,0 +1,29 @@
|
||||
## Reference Picker
|
||||
|
||||
The Reference Picker tool allows you to search for and insert citation keys from the project's bib files.
|
||||
|
||||
When you press `Ctrl-Space` inside a citation command such as `\cite{}`, `\citep{}`, or `\citet{}`, the Reference Picker
|
||||
dialog appears. In this dialog, you can search for references and select the ones whose citation keys should be inserted into the citation command.
|
||||
|
||||
<div align="center">
|
||||
<img src="images/Reference-Picker-Insert.png"
|
||||
width="600"
|
||||
>
|
||||
<br>
|
||||
<em>Insert mode</em>
|
||||
</div>
|
||||
<br>
|
||||
|
||||
|
||||
In addition to Insert mode, the Reference Picker provides Replace mode. It is activated when one or more citation keys inside a citation command are highlighted in the editor.
|
||||
In this mode, the highlighted citation keys are replaced with the citation keys chosen in the Reference Picker. Citation keys that are not highlighted remain unchanged.
|
||||
|
||||
It is not necessary to highlight the entire citation key. If only part of a key is highlighted in the editor, the Reference Picker automatically detects the corresponding key.
|
||||
|
||||
<div align="center">
|
||||
<img src="images/Reference-Picker-Replace.png"
|
||||
width="600"
|
||||
>
|
||||
<br>
|
||||
<em>Replace mode</em>
|
||||
</div>
|
||||
@@ -15,7 +15,7 @@ For example: `EXTERNAL_AUTH=ldap saml`
|
||||
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:
|
||||
|
||||
```
|
||||
```bash
|
||||
samlIdentifiers: [
|
||||
{
|
||||
externalUserId: "...",
|
||||
@@ -164,7 +164,7 @@ Below is an example of appropriate Service Provider metadata:
|
||||
<details>
|
||||
<summary><h5>ol-meta.xml</h5></summary>
|
||||
|
||||
```
|
||||
```xml
|
||||
<?xml version="1.0"?>
|
||||
<EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata"
|
||||
xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
|
||||
@@ -212,7 +212,7 @@ and set as appropriate in your IdP configuration, or send the metadata file to t
|
||||
<details>
|
||||
<summary><h4>Sample variables.env file</h4></summary>
|
||||
|
||||
```
|
||||
```bash
|
||||
OVERLEAF_APP_NAME="Our Overleaf Instance"
|
||||
|
||||
ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
## Sign Up Page
|
||||
|
||||
The **Sign Up** page allows the site administrator to let users register themselves on an Overleaf CE+ server.
|
||||
|
||||
<div align="center">
|
||||
<img src="images/Sign-Up-Page.png"
|
||||
width="600"
|
||||
>
|
||||
</div>
|
||||
|
||||
The behavior of the registration page is controlled by the following environment variables:
|
||||
|
||||
- `OVERLEAF_ENABLE_REGISTRATION_PAGE`
|
||||
|
||||
* If set to `true`, the **Sign Up** page is enabled.
|
||||
* If set to `false`, the **Sign Up** page is disabled.
|
||||
* If not set, the **Sign Up** page is disabled if any external authentication method is enabled; otherwise, it is enabled.
|
||||
|
||||
- `OVERLEAF_ALLOWED_REGISTRATION_EMAIL_DOMAINS`
|
||||
|
||||
* If defined, restricts user registration to email addresses whose domain matches one of the configured domains.
|
||||
* The value is a whitespace- or comma-separated list of domain names.
|
||||
* Domain names may include a leading `*.` wildcard to match subdomains.
|
||||
|
||||
**Example:** To allow registration for users with email addresses such as `name@mymail.org`, `name@company.com`, `name@math.company.com`, and `name@sub.example.org`, set:
|
||||
|
||||
```bash
|
||||
OVERLEAF_ALLOWED_REGISTRATION_EMAIL_DOMAINS=mymail.org, company.com, *.company.com, *.example.org
|
||||
```
|
||||
|
||||
Note, this configuration does **not** allow `name@example.org`.
|
||||
@@ -51,7 +51,7 @@ Users can manage their own templates, while admins and the user with the ID defi
|
||||
<details>
|
||||
<summary><h4>Example</h4></summary>
|
||||
|
||||
```
|
||||
```bash
|
||||
#################
|
||||
# TEMPLATES #
|
||||
#################
|
||||
|
||||
@@ -0,0 +1,69 @@
|
||||
## Zotero Integration
|
||||
|
||||
The Zotero integration feature allows you to import your Zotero **My Library** or individual Group Libraries to create a *read-only* `.bib` file that can be synchronized with your Zotero account.
|
||||
For details, refer to the [Overleaf documentation](https://docs.overleaf.com/integrations-and-add-ons/reference-manager-integrations/zotero).
|
||||
|
||||
Please note that the CE+ implementation still lacks what is called "advanced reference search" in the upstream implementation. Currently, it is only possible to bulk-import references to create a non-editable `.bib` file.
|
||||
Importing individual references into editable `.bib` files is not yet implemented.
|
||||
|
||||
To enable Zotero integration in CE+, the site administrator must [register an OAuth application with Zotero](https://www.zotero.org/oauth/apps) to obtain a Client Key and Client Secret, and define the following environment variables:
|
||||
|
||||
```bash
|
||||
ZOTERO_CLIENT_KEY=xxxxxxxxxxxxxxxxxxxx
|
||||
ZOTERO_CLIENT_SECRET=xxxxxxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
Additionally, `zotero` must be added to the `ENABLED_LINKED_FILE_TYPE` environment variable:
|
||||
```
|
||||
ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url,zotero
|
||||
```
|
||||
|
||||
Zotero authorization tokens are stored in MongoDB in encrypted form. By default, a random encryption password is generated on the first startup and stored in the following file:
|
||||
|
||||
```text
|
||||
/var/lib/overleaf/data/.token-cipher.json
|
||||
```
|
||||
|
||||
> **Note:** This file is also used by default to store the encryption password for GitHub authorization tokens.
|
||||
|
||||
Once this file has been created, keep it safe and do not delete it. Otherwise, all users whose authorization tokens were encrypted with the password stored in this file will need to reconnect their Zotero accounts.
|
||||
|
||||
<details>
|
||||
<summary><h4>Technical details</h4></summary>
|
||||
|
||||
If necessary, you can create this file manually. It has the following format:
|
||||
|
||||
```json
|
||||
{
|
||||
"cipherLabel": "OL_CEP-v3",
|
||||
"cipherPasswords": {
|
||||
"OL_CEP-v3": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
||||
"2026.7-v3": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
In most cases, a single password is sufficient.
|
||||
|
||||
The `cipherLabel` field specifies which entry from `cipherPasswords` is used to encrypt newly created tokens. The label format is almost arbitrary: it must not contain a colon (`:`), and it must end with the suffix `-v3`.
|
||||
|
||||
You can change the default location of the file using environment variables:
|
||||
- `ZOTERO_TOKEN_CIPHER_FILE` or `TOKEN_CIPHER_FILE`
|
||||
* Specifies the location of the password file. If both are defined, `ZOTERO_TOKEN_CIPHER_FILE` takes precedence.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
ZOTERO_TOKEN_CIPHER_FILE=/var/lib/overleaf/data/.zotero-token-cipher.json
|
||||
```
|
||||
|
||||
Alternatively, you can define the encryption password directly using environment variables instead of a file:
|
||||
|
||||
- `ZOTERO_TOKEN_CIPHER_PASSWORD` or `TOKEN_CIPHER_PASSWORD`
|
||||
* Specifies the encryption password. If both are defined, `ZOTERO_TOKEN_CIPHER_PASSWORD` takes precedence.
|
||||
* **If either of these variables is defined, the password file is ignored.**
|
||||
- `ZOTERO_TOKEN_CIPHER_LABEL` or `TOKEN_CIPHER_LABEL`
|
||||
* Specifies the label associated with the encryption password. If both are defined, `ZOTERO_TOKEN_CIPHER_LABEL` takes precedence.
|
||||
* Defaults to `OL_CEP-v3`.
|
||||
|
||||
</details>
|
||||
+42
-21
@@ -1,29 +1,45 @@
|
||||
|
||||
This is the home of Overleaf Extended Community Edition.
|
||||
This is the home of Overleaf CE+.
|
||||
|
||||
## Setup
|
||||
|
||||
The [Overleaf Toolkit](https://github.com/overleaf/toolkit) is the recommended way to deploy and manage Overleaf Extended Community Edition. We encourage new Overleaf users to get started with the Toolkit [Quick Start Guide](https://github.com/overleaf/toolkit/blob/master/doc/quick-start-guide.md).
|
||||
The [Overleaf Toolkit](https://github.com/overleaf/toolkit) is the recommended way to deploy and manage Overleaf CE+. We encourage new Overleaf users to get started with the Toolkit [Quick Start Guide](https://github.com/overleaf/toolkit/blob/master/doc/quick-start-guide.md).
|
||||
|
||||
The [legacy instructions](https://github.com/overleaf/overleaf/wiki/Quick-Start-Guide) remain in place for existing `docker-compose` based deployments.
|
||||
|
||||
General information on setting up and managing Overleaf, as well as upstream release notes, can be found on
|
||||
the [Overleaf Wiki Page](https://github.com/overleaf/overleaf/wiki).
|
||||
|
||||
## Extended CE Release Notes
|
||||
## Overleaf CE+ Release Notes
|
||||
|
||||
### `v6.1.2-ext-v4.1`
|
||||
<h3><code>v6.2.0-ext-v5.0</code></h3>
|
||||
|
||||
- Based on upstream release v6.2.0
|
||||
- Added GitHub integration
|
||||
- Added support for downloading bib-files from Zotero
|
||||
- Added a reference picker for inserting and editing citation keys inside `\cite{}`
|
||||
- Added a self-registration page
|
||||
- Added an *Active Projects* page to the admin tools
|
||||
- Added *Logo Tools* to simplify rebranding
|
||||
- Added the `ENABLE_EDITOR_TABS` environment variable to enable the experimental upstream editor tabs feature
|
||||
- Added the `ENABLE_PANDOC_CONVERSIONS` environment variable to enable the experimental upstream Pandoc conversion features:
|
||||
- Import Microsoft Word and Markdown documents
|
||||
- Export TeX documents as Microsoft Word, Markdown, or HTML
|
||||
- Removed the `OVERLEAF_THEMED_DASHBOARD` environment variable (the themed dashboard is no longer experimental upstream and is now always enabled)
|
||||
- Various bug fixes
|
||||
|
||||
<h3><code>v6.1.2-ext-v4.1</code></h3>
|
||||
|
||||
- Git Bridge: fixed wrong router for PAT validation endpoint
|
||||
- Git Bridge: use `GIT_*` environment variables to generate nginx configuration
|
||||
- Admin tools: introduced themed dashboard suppot
|
||||
- Introduced environment variable `OVERLEAF_THEMED_DASHBOARD` to enable experimental themed dashboards
|
||||
|
||||
### `v6.1.2-ext-v4.0`
|
||||
<h3><code>v6.1.2-ext-v4.0</code></h3>
|
||||
|
||||
- Based on upstream release v6.1.2
|
||||
- Introduced Git integration
|
||||
- Added environment variable `OVERLEAF_HISTORY_RESTORE` to enable restoring a project or file from a history snapshot,
|
||||
see [Environment Variables](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-Environment-Variables)
|
||||
see [Environment Variables](Extended-CE%3A-Environment-Variables)
|
||||
- Administrator tools: significantly improved page rendering performance when handling large numbers of users or projects; added pagination to user and project lists
|
||||
- Template gallery: **security fix** — non-privileged user could manage a template not owned by that user
|
||||
- Template gallery: introduced template manager role (environment variable `OVERLEAF_TEMPLATES_USER_ID`)
|
||||
@@ -32,25 +48,29 @@ the [Overleaf Wiki Page](https://github.com/overleaf/overleaf/wiki).
|
||||
- Sandboxed compiles: set `imageName` to default when undefined on the first project opening (for migration from CE)
|
||||
- Sandboxed compiles: - Sandboxed compiles: added scripts to add or remove the repository prefix in project `imageName`
|
||||
|
||||
### `v6.1.1-ext-v3.5`
|
||||
<h3><code>v6.1.1-ext-v3.5</code></h3>
|
||||
|
||||
- Based on upstream release v6.1.1
|
||||
- New design of the Overleaf editor (supports light and dark themes)
|
||||
- Introduced `TEX_LIVE_DOCKER_IMAGE_ROOT` environment variable to simplify changing TeX Live Docker images.
|
||||
For details, see [Sandboxed Compiles](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-Sandboxed-Compiles)
|
||||
For details, see [Sandboxed Compiles](Extended-CE%3A-Sandboxed-Compiles)
|
||||
- Introduced `OVERLEAF_EMAIL_SMTP_PASS_FILE` envirionment variable
|
||||
- Fixed several bugs in tools for administrators to manage users and projects
|
||||
- Fixed support for Sandboxed compiles on arm64 architecture
|
||||
|
||||
### `v6.0.1-ext-v3.4`
|
||||
<h3><code>v6.0.1-ext-v3.4</code></h3>
|
||||
|
||||
- Introduced advanced tools for administrators to manage users and projects
|
||||
|
||||
### `v6.0.1-ext-v3.3`
|
||||
<h3><code>v6.0.1-ext-v3.3</code></h3>
|
||||
|
||||
- Based on upstream release v6.0.1
|
||||
|
||||
### `v6.0.0-ext-v3.3`
|
||||
<h3><code>v6.0.0-ext-v3.3</code></h3>
|
||||
|
||||
- **Security fix**: external URLs are now normalized and sanitized
|
||||
|
||||
### `v6.0.0-ext-v3.2`
|
||||
<h3><code>v6.0.0-ext-v3.2</code></h3>
|
||||
|
||||
- Based on upstream release v6.0.0
|
||||
|
||||
@@ -59,31 +79,32 @@ For details, see [Sandboxed Compiles](https://github.com/yu-i-i/overleaf-cep/wik
|
||||
|
||||
>⚠️ **New Extended CE versions based on upstream 5.X.Y will no longer be produced, except for security fixes for a limited period. If you want to keep receiving feature updates, upgrade to v6.0.0-ext-vX.Y.**
|
||||
|
||||
### `v5.5.6-ext-v3.3`
|
||||
<h3><code>v5.5.6-ext-v3.3</code></h3>
|
||||
|
||||
- **Security fix**: external URLs are now normalized and sanitized. The image should be updated using `5.5.6-ext-3.3` hotfix.
|
||||
|
||||
### `v5.5.6-ext-v3.2`
|
||||
<h3><code>v5.5.6-ext-v3.2</code></h3>
|
||||
|
||||
- Based on upstream release v5.5.6
|
||||
- Fixed an issue where Sandboxed Compiles stopped working due to excessively strict seccomp restrictions
|
||||
- Introduced the `MAX_UPLOAD_SIZE` variable to control the maximum allowed size for uploaded projects and files
|
||||
- **Security fix**: Files attached from an external URL are now fetched through a proxy. For details, see [Security Note](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-From-External-URL#security-note)
|
||||
- **Security fix**: Files attached from an external URL are now fetched through a proxy. For details, see [Security Note](Extended-CE%3A-From-External-URL#security-note)
|
||||
|
||||
### `v5.5.4-ext-v3.1`
|
||||
<h3><code>v5.5.4-ext-v3.1</code></h3>
|
||||
|
||||
- Based on upstream release v5.5.4
|
||||
|
||||
### `v5.5.2-ext-v3.1`
|
||||
<h3><code>v5.5.2-ext-v3.1</code></h3>
|
||||
|
||||
- Based on upstream release v5.5.2
|
||||
- Added `OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS` variable to restrict JIT account creation for users
|
||||
authenticating via OIDC, based on their email domains
|
||||
|
||||
### `v5.5.0-ext-v3`
|
||||
<h3><code>v5.5.0-ext-v3</code></h3>
|
||||
|
||||
- Based on upstream release v5.5.0
|
||||
|
||||
### `v5.4.1-ext-v3`
|
||||
<h3><code>v5.4.1-ext-v3</code></h3>
|
||||
|
||||
- Based on upstream release v5.4.1
|
||||
- Sandboxed compiles: Made the `TEX_LIVE_DOCKER_IMAGE` environment variable optional
|
||||
@@ -91,7 +112,7 @@ For details, see [Sandboxed Compiles](https://github.com/yu-i-i/overleaf-cep/wik
|
||||
- Template Gallery: improved visual presentation of modals and enhanced keyboard interactions
|
||||
- Template Gallery **breaking change**: Replaced the free-text license field with a dropdown (select box)
|
||||
|
||||
### `v5.4.0-ext-v2`
|
||||
<h3><code>v5.4.0-ext-v2</code></h3>
|
||||
|
||||
- Added "From External URL" feature
|
||||
- Introduced Template Gallery
|
||||
|
||||
+16
-10
@@ -1,10 +1,16 @@
|
||||
## Extended CE
|
||||
- [Installation](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-Installation)
|
||||
- [Sandboxed Compiles](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-Sandboxed-Compiles)
|
||||
- [LDAP Authentication](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-LDAP-Authentication)
|
||||
- [SAML Authentication](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-SAML-Authentication)
|
||||
- [OIDC Authentication](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-OIDC-Authentication)
|
||||
- [Template Gallery](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-Template-Gallery)
|
||||
- [From External URL Feature](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-From-External-URL)
|
||||
- [Environment Variables](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-Environment-Variables)
|
||||
- [Useful Links](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-Useful-Links)
|
||||
## Overleaf CE+
|
||||
- [Installation](Extended-CE%3A-Installation)
|
||||
- [Sandboxed Compiles](Extended-CE%3A-Sandboxed-Compiles)
|
||||
- [LDAP Authentication](Extended-CE%3A-LDAP-Authentication)
|
||||
- [SAML Authentication](Extended-CE%3A-SAML-Authentication)
|
||||
- [OIDC Authentication](Extended-CE%3A-OIDC-Authentication)
|
||||
- [Template Gallery](Extended-CE%3A-Template-Gallery)
|
||||
- [Git Integration](Extended-CE%3A-Git-Integration)
|
||||
- [GitHub Synchronization](Extended-CE%3A-GitHub-Synchronization)
|
||||
- [Zotero Integration](Extended-CE%3A-Zotero-Integration)
|
||||
- [Reference Picker](Extended-CE%3A-Reference-Picker)
|
||||
- [From External URL Feature](Extended-CE%3A-From-External-URL)
|
||||
- [Pandoc Conversion](Extended-CE%3A-Pandoc-Conversion)
|
||||
- [Sign Up Page](Extended-CE%3A-Sign-Up-Page)
|
||||
- [Environment Variables](Extended-CE%3A-Environment-Variables)
|
||||
- [Useful Links](Extended-CE%3A-Useful-Links)
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 119 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 164 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 138 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
Reference in New Issue
Block a user