mirror of
https://github.com/yu-i-i/overleaf-cep.git
synced 2026-05-23 09:09:36 +02:00
Update README.md
This commit is contained in:
8
.github/ISSUE_TEMPLATE/bug_report.md
vendored
8
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -8,12 +8,8 @@ assignees: ''
|
|||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
|
||||||
Note: If you are using www.overleaf.com and have a problem,
|
Note: This form should only be used to report bugs in the
|
||||||
or if you would like to request a new feature please contact
|
Extended CE release of Overleaf.
|
||||||
the support team at support@overleaf.com
|
|
||||||
|
|
||||||
This form should only be used to report bugs in the
|
|
||||||
Community Edition release of Overleaf.
|
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|||||||
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -5,7 +5,3 @@
|
|||||||
## Related issues / Pull Requests
|
## Related issues / Pull Requests
|
||||||
|
|
||||||
<!-- Fixes #xyz, Contributes to #xyz, Related to #xyz-->
|
<!-- Fixes #xyz, Contributes to #xyz, Related to #xyz-->
|
||||||
|
|
||||||
## Contributor Agreement
|
|
||||||
|
|
||||||
- [ ] I confirm I have signed the [Contributor License Agreement](https://github.com/overleaf/overleaf/blob/main/CONTRIBUTING.md#contributor-license-agreement)
|
|
||||||
|
|||||||
@@ -1,38 +1,29 @@
|
|||||||
# Contributing to Overleaf
|
# Contributing to Overleaf CE+
|
||||||
|
|
||||||
Thank you for reading this! If you'd like to report a bug or join in the development
|
Thank you for reading this! If you'd like to report a bug or join in the development
|
||||||
of Overleaf, then here are some notes on how to do that.
|
of Overleaf CE+, then here are some notes on how to do that.
|
||||||
|
|
||||||
## Reporting bugs and opening issues
|
## Reporting bugs and opening issues
|
||||||
|
|
||||||
If you'd like to report a bug or open an issue, please **[check if there is an existing issue](https://github.com/overleaf/overleaf/issues).**
|
If you'd like to report a bug or open an issue, please **[check if there is an existing issue](https://github.com/yu-i-i/overleaf-cep).**
|
||||||
If there is then please add any more information that you have, or give it a 👍.
|
If there is then please add any more information that you have, or give it a 👍.
|
||||||
|
|
||||||
When submitting an issue please describe the issue as clearly as possible, including how to
|
When submitting an issue please describe the issue as clearly as possible, including how to
|
||||||
reproduce the bug, which situations it appears in, what you expected to happen, and what actually happens.
|
reproduce the bug, which situations it appears in, what you expected to happen, and what actually happens.
|
||||||
If you can include a screenshot for front end issues that is very helpful.
|
If you can include a screenshot for front end issues that is very helpful.
|
||||||
|
|
||||||
**Note**: If you are using [www.overleaf.com](www.overleaf.com) and have a problem, or if you would like to request a new feature, please contact the Support team at support@overleaf.com. Raise an issue here only to report bugs in the Community Edition release of Overleaf.
|
|
||||||
|
|
||||||
## Pull Requests
|
## Pull Requests
|
||||||
|
|
||||||
See [our wiki](https://github.com/overleaf/overleaf/wiki)
|
See [Overleaf wiki](https://github.com/overleaf/overleaf/wiki)
|
||||||
for how to manage the Overleaf development environment and for our developer guidelines.
|
for how to manage the Overleaf development environment and for our developer guidelines.
|
||||||
|
|
||||||
We love pull requests, so be bold with them! Don't be afraid of going ahead
|
We love pull requests, so be bold with them! Don't be afraid of going ahead
|
||||||
and changing something, or adding a new feature. We're very happy to work with you
|
and changing something, or adding a new feature. We're very happy to work with you
|
||||||
to get your changes merged into Overleaf.
|
to get your changes merged into Overleaf.
|
||||||
|
|
||||||
If you're looking for something to work on, have a look at the [open issues](https://github.com/overleaf/overleaf/issues).
|
If you're looking for something to work on, have a look at the [open issues](https://github.com/yu-i-i/overleaf-cep/issues).
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
Please see [our security policy](https://github.com/overleaf/overleaf/security/policy) if you would like to report a potential security vulnerability.
|
Please see [Overleaf security policy](https://github.com/overleaf/overleaf/security/policy) if you would like to report a potential security vulnerability.
|
||||||
|
|
||||||
## Contributor License Agreement
|
|
||||||
|
|
||||||
Before we can accept any contributions of code, we need you to agree to our
|
|
||||||
[Contributor License Agreement](https://docs.google.com/forms/d/e/1FAIpQLSef79XH3mb7yIiMzZw-yALEegS-wyFetvjTiNBfZvf_IHD2KA/viewform?usp=sf_link).
|
|
||||||
This is to ensure that you own the copyright of your contribution, and that you
|
|
||||||
agree to give us a license to use it in both the open source version, and the version
|
|
||||||
of Overleaf running at www.overleaf.com, which may have additional changes.
|
|
||||||
|
|||||||
70
CREDITS.md
Normal file
70
CREDITS.md
Normal file
@@ -0,0 +1,70 @@
|
|||||||
|
# CREDITS
|
||||||
|
|
||||||
|
This project includes ideas and adapted code from several open-source projects.\
|
||||||
|
In most cases the original code has been modified, optimized, or extended.
|
||||||
|
|
||||||
|
## Symbol palette
|
||||||
|
|
||||||
|
The symbol palette feature is based on the original Overleaf implementation:
|
||||||
|
|
||||||
|
https://github.com/overleaf/web/tree/master/frontend/js/features/symbol-palette
|
||||||
|
|
||||||
|
The original code was slightly improved, particularly in the parts related to keyboard input.
|
||||||
|
|
||||||
|
## LDAP authentication
|
||||||
|
|
||||||
|
LDAP authentication was inspired by:
|
||||||
|
|
||||||
|
https://github.com/smhaller/ldap-overleaf-sl
|
||||||
|
|
||||||
|
The project provided the idea and part of the implementation for adding LDAP users to the user's contacts.
|
||||||
|
|
||||||
|
## Autocomplete of reference keys
|
||||||
|
|
||||||
|
Autocomplete of reference keys is based on:
|
||||||
|
|
||||||
|
https://github.com/lcpu-club/overleaf
|
||||||
|
|
||||||
|
The implementation largely follows the referenced code, except that a different `.bib` file parser is used.
|
||||||
|
|
||||||
|
## Real-time track changes and comments
|
||||||
|
|
||||||
|
The Track Changes and Comments feature exists largely in the original Overleaf codebase.\
|
||||||
|
The missing parts were implemented based on:
|
||||||
|
|
||||||
|
https://github.com/ertuil/overleaf
|
||||||
|
|
||||||
|
The referenced code was fixed, optimized, and extended.
|
||||||
|
|
||||||
|
## Sandboxed compiles
|
||||||
|
|
||||||
|
The Sandboxed Compiles feature was until recently largely present in the original Overleaf codebase.\
|
||||||
|
The missing parts were implemented in this project.
|
||||||
|
|
||||||
|
## Import file from external URL
|
||||||
|
|
||||||
|
The "From External URL" feature exists in the original Overleaf code.\
|
||||||
|
The missing proxy component was implemented in this project.
|
||||||
|
|
||||||
|
## Git integration
|
||||||
|
|
||||||
|
Git integration is based on:
|
||||||
|
|
||||||
|
https://github.com/ayaka-notes/overleaf-pro/tree/feat-git-bridge
|
||||||
|
|
||||||
|
The backend was completely rewritten.\
|
||||||
|
The frontend uses the referenced code, which was optimized and improved.
|
||||||
|
|
||||||
|
## Original Features
|
||||||
|
|
||||||
|
The following features are original work implemented in this project:
|
||||||
|
|
||||||
|
- Template Gallery
|
||||||
|
- Advanced administrator tools for managing user accounts and projects
|
||||||
|
- SAML authentication
|
||||||
|
- OpenID Connect authentication
|
||||||
|
|
||||||
|
## Acknowledgments
|
||||||
|
|
||||||
|
Thanks to the users of the project for valuable feedback, suggestions,
|
||||||
|
and help in identifying and fixing bugs.
|
||||||
18
README.md
18
README.md
@@ -25,16 +25,17 @@
|
|||||||
|
|
||||||
The present "extended" version of Overleaf CE includes:
|
The present "extended" version of Overleaf CE includes:
|
||||||
|
|
||||||
- Template Gallery
|
- Template gallery
|
||||||
- Sandboxed Compiles with TeX Live image selection
|
- Sandboxed compiles with TeX Live image selection
|
||||||
- LDAP authentication
|
- LDAP authentication
|
||||||
- SAML authentication
|
- SAML authentication
|
||||||
- OpenID Connect authentication
|
- OpenID Connect authentication
|
||||||
- Real-time track changes and comments
|
- Real-time track changes and comments
|
||||||
- Autocomplete of reference keys
|
- Autocomplete of reference keys
|
||||||
- Symbol Palette
|
- Symbol palette
|
||||||
- "From External URL" feature
|
- Import file from external URL
|
||||||
- Advanced administrator tools for managing user accounts and projects
|
- Advanced administrator tools for managing user accounts and projects
|
||||||
|
- Git integration
|
||||||
|
|
||||||
> [!CAUTION]
|
> [!CAUTION]
|
||||||
> Overleaf Community Edition is intended for use in environments where **all** users are trusted. Community Edition is **not** appropriate for scenarios where isolation of users is required due to Sandbox Compiles not being available. When not using Sandboxed Compiles, users have full read and write access to the `sharelatex` container resources (filesystem, network, environment variables) when running LaTeX compiles.
|
> Overleaf Community Edition is intended for use in environments where **all** users are trusted. Community Edition is **not** appropriate for scenarios where isolation of users is required due to Sandbox Compiles not being available. When not using Sandboxed Compiles, users have full read and write access to the `sharelatex` container resources (filesystem, network, environment variables) when running LaTeX compiles.
|
||||||
@@ -74,11 +75,14 @@ folder are added.
|
|||||||
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
[The Overleaf Team](https://www.overleaf.com/about)
|
[The Overleaf Team](https://www.overleaf.com/about)\
|
||||||
[yu-i-i](https://github.com/yu-i-i/overleaf-cep) — Extensions for CE unless otherwise noted
|
[yu-i-i](https://github.com/yu-i-i/overleaf-cep) — CE extensions; references to adapted code are listed in [`CREDITS`](CREDITS.md)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the [`LICENSE`](LICENSE) file.
|
The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the [`LICENSE`](LICENSE) file.
|
||||||
|
|
||||||
Copyright (c) Overleaf, 2014-2025.
|
Copyright (c) Overleaf, 2014-2026.\
|
||||||
|
Copyright (c) yu-i-i, 2024-2026, for CE extensions.
|
||||||
|
|
||||||
|
Portions of the code are derived from other open-source projects; see [`CREDITS`](CREDITS.md).
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 271 KiB After Width: | Height: | Size: 525 KiB |
Reference in New Issue
Block a user