libretic/etherpad-lite
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
6662 commits 2 branches 0 tags 24 MiB
Commit graph

249 commits

Author SHA1 Message Date
muxator
8d39cc4db2 docker: fill in the default values in the documentation 2020-04-21 04:44:56 +02:00
muxator
a0b5e515aa docker: switch to table layout in the docs about the available settings 
In this way, we also gain an explicit place for the default setting (still not
filled in).

No functional changes.
This is in preparation of a future commit by Paul Tiedke.
 2020-04-21 04:44:56 +02:00
muxator
ca3d095d35 docker: in the db documentation, specify that we are not going to include every single variable a driver may want 2020-04-21 04:44:56 +02:00
muxator
f08d517625 docker: in the documentation, reorganize categorically the available parameters 
No functional changes.
This is in preparation of a future commit by Paul Tiedke.
 2020-04-21 04:44:56 +02:00
Sebastian Castro
11f88a9b36 Update Readme with new screenshots 
closes #2140
closes #3779
 2020-04-19 18:05:59 +02:00
muxator
5ade38c86b docker: build & run the container in production mode 
This is leaner (no development dependencies are included in the container) and
faster (among other things, assets are minified & compressed).
 2020-04-19 04:41:29 +02:00
muxator
5acbdb83e5 docker: allow to control import/export rate limiting parameters 
The newly introduces environment variables are IMPORT_EXPORT_RATE_LIMIT_WINDOW
and IMPORT_EXPORT_MAX_REQ_PER_IP.
 2020-04-14 03:36:13 +02:00
muxator
f5d9b94ca1 docker: allow to control the maximum file size of an import via IMPORT_MAX_SIZE 2020-04-14 03:36:13 +02:00
muxator
684f374ece runtime: require node >= 10.13.0 LTS 
At the moment, NodeJS 10.x is the lowest supported LTS version. NodeJS 8.x is no
longer supported upstream.

Implements #3835.
Planned in #3650.
 2020-04-09 04:43:37 +02:00
Paul Tiedtke
79406051fa Settings.js: support newlines in default values when using variable substitution 
This allows, among other things, to correctly support the configuration of
defaultPadText in Docker via an environment variable.
 2020-04-07 04:32:37 +02:00
Chocobozzz
82b919fc65 api: add getStats() function 2020-04-04 22:03:46 +02:00
Viljami Kuosmanen
e821bbcad8 openapi: add documentation, small optimisation 2020-04-03 01:03:11 +02:00
Neil Oosten
7a999ee398 hooks: allow to set the duration of the gritter notification when a new chat message arrives 
This is done adding a new "duration" parameter to the chatNewMessage() client
side hook.
 2020-03-27 02:39:29 +01:00
muxator
8a01a5e437 doc: fix numbering in chatNewMessage() client hook parameters 
This was originally introduced in bcb92f25a6 ("Refactor chat notifications and
the chatNewMessage hook") from 2013-03-19.
 2020-03-27 02:39:29 +01:00
John McLear
6fd2bf4472 hooks: introduce goToRevisionEvent(), a new client-side hook 
This hook gets fired both on timeslider load (as timeslider shows a new
revision) and when the new revision is showed to a user.
 2020-03-24 23:46:17 +01:00
Pierre Prinetti
0b3cf7cc96 docker: Add Run with volume example 
Supersedes https://github.com/ether/etherpad-lite/pull/3631

Co-authored-by: RaymondCavallaro <RaymondCavallaro@users.noreply.github.com>
 2019-12-25 00:48:30 +01:00
muxator
a817acbbcc security: when served over https, set the "secure" flag for "express_sid" and "language" cookie 
The mechanism used for determining if the application is being served over SSL
is wrapped by the "express-session" library for "express_sid", and manual for
the "language" cookie, but it's very similar in both cases.

The "secure" flag is set if one of these is true:

1. we are directly serving Etherpad over SSL using the native nodejs
   functionality, via the "ssl" options in settings.json

2. Etherpad is being served in plaintext by nodejs, but we are using a reverse
   proxy for terminating the SSL for us;
   In this case, the user has to be instructed to properly set trustProxy: true
   in settings.json, and the information wheter the application is over SSL or
   not will be extracted from the X-Forwarded-Proto HTTP header.

Please note that this will not be compatible with applications being served over
http and https at the same time.

The change on webaccess.js amends 009b61b338, which did not work when the SSL
termination was performed by a reverse proxy.

Reference for automatic "express_sid" configuration:
https://github.com/expressjs/session/blob/v1.17.0/README.md#cookiesecure

Closes #3561.
 2019-12-07 04:36:01 +01:00
muxator
30fd53f1fd docker: move docker/settings.json to /settings.json.docker 2019-11-08 23:50:50 +01:00
Pierre Prinetti
dc15f4a43c docker: build from the local working directory 
With this change, the Dockerfile builds the Docker image from the code
checked out in the local filesystem, instead of downloading a revision
from git.

Implements #3657
 2019-11-08 22:56:30 +01:00
muxator
c008ee36bd docker: incorporate the docker docs into the official documentation 
This also means increasing the indentation level.
 2019-11-08 23:17:34 +01:00
muxator
312c72c364 formatting: bulk remove trailing whitespaces 
Do not touch vendorized files (e.g. libraries that were imported from external
projects).

No functional changes.

Command:
    find . -name '*.<EXTENSION>' -type f -print0 | xargs -0 sed -i 's/[[:space:]]*$//'
 2019-10-20 02:09:22 +02:00
Ray Bellis
fc661ee13a core: allow URL parameters and POST bodies to co-exist. 
Node 8.14.0 prohibits HTTP headers that exceed 8 KB (source:
https://nodejs.org/en/blog/vulnerability/november-2018-security-releases/#denial-of-service-with-large-http-headers-cve-2018-12121).

This patch allows for the parameters within the body of an HTTP POST request to
be used in addition to those within the URL (and will override them).

Closes #3568.

---
Muxator 2019-10-19:
- this commit was cherry-picked from 882b93487f
- it was modified to include the necessary changes in the documentation
 2019-06-27 00:52:53 +02:00
muxator
705cc6f5e4 Change everywhere the link to https://etherpad.org (it was plain http) 2019-04-16 00:54:54 +02:00
muxator
9d35d15ae3 node8: require nodejs >= 8.9.0, npm >= 6.4 
Next version will be Etherpad 1.8. As planned in #3424, we are going to require
NodeJS >=8.9.0 and npm >= 6.4.

This commit implements that change and updates documentation and scripts.
Subsequent changes will get rid of old idioms, dating back to node < 0.7, that
still survive in the code.
Once migrated to NodeJS 8, we will be able to start working on migrating the
code base from callbacks to async/await, greatly simplifying legibility (see
#3540).

Closes #3557
 2019-02-19 22:01:12 +01:00
muxator
4f0a2785da release: prepare for 1.7.5 
Written the changelog and updated package.json.
 2019-01-26 00:16:03 +01:00
HairyFotr
fce55df2b7 Fix typos 2019-01-16 11:14:04 +01:00
muxator
aca8fae682 easysync-full-description: regenerate the pdf document 
The .tex source was updated to fix some typos, but the corresponding pdf was not
regenerated.

Command used to generate the pdf:
  pdflatex easysync-full-description.tex

The incorporated changes are:
- 49114d2b7a (2014-06-01)
- c7548450c0 (2017-09-14)
 2018-12-09 15:56:17 +01:00
muxator
66d87babfa doc: passwordHash does not contain a bcrypted password, but a salted sha512 sum 
The documentation was written on 2011-08-03:
    31067f163f: added a documentation for the database structure

The implementation using sha512 instead of bcrypt was committed two days later,
on 2011-08-10:
    ce1012438e: added setPublicStatus, getPublicStatus, setPassword and isPasswordProtected
 2018-11-05 22:45:00 +01:00
muxator
23eab79946 pad.html: for each client plugin, add a class to #editorcontainerbox 
This commit implements the following behaviour:

1. adds a function clientPluginNames() to hooks.js (mimicking what is done in
   static.js), which returns an array containing the list of currently installed
   client side plugins. The array is eventually empty.

2. calls that function in pad.html at rendering time (thus server-side) to
   populate a class attribute.

Example results:
- with no client-side plugins installed:
  <div id="editorcontainerbox" class="">

- with some client-side plugins installed:
  <div id="editorcontainerbox" class="ep_author_neat ep_adminpads">

Looking at the existing code (src/node/hooks/express/static.js#L39-L57), a
client-side plugin is defined as a plugin that implements at least a client side
hook.

NOTE: there is currently no support for notifying plugin removal/installation
      to the connected clients: for now, in order to get an updated class list,
      the clients will have to refresh the page.

Fixes #3488
 2018-10-02 21:22:13 +02:00
muxator
6620014b77 skins: describe the skins in the documentation 2018-08-26 21:17:04 +02:00
"muxator ext:(%22)
d499e1b046 docs: direct link to measured.Collection from stats.md 2018-08-14 13:27:31 +02:00
muxator
e9fb63f426 docs: "``js" -> "``json" in Markdown of some json blocks 2018-08-09 22:27:56 +02:00
muxator
7544585908 runtime: enforce minimal node version to 6.9.0 
Etherpad 1.6.6 does not run on node <= 5 already.
Node 6.9 is the first LTS release in the 6 series, and comes with npm 3.10.8.

Declarations in package.json are advisory unless the user has set
`engine-strict` config flag.

Updated the docs accordingly.
 2018-07-28 23:33:24 +02:00
John McLear
2765a95774
Merge pull request #3218 from klausweiss/develop 
Feature: New server-side hook: onAccessCheck
 2018-04-03 13:38:47 +01:00
HairyFotr
c7548450c0
Typos and minor fixes in bin, doc, and root 2017-09-14 13:33:27 +02:00
Mikołaj Biel
5c8a15c3d7 fix sessionCookie number in onAccessCheck 2017-07-12 00:28:51 +02:00
Mikołaj Biel
35702a0589 [feat] New server-side hook: onAccessCheck 2017-07-10 20:54:32 +02:00
Luiza Pagliari
fc89034a55 [feat] New server-side hook: padCopy 
Let plugins know when a pad is copied.
 2017-05-18 18:52:14 -03:00
Luiza Pagliari
d78681350b Merge pull request #3149 from AdamNiederer/patch-1 
Remove an extra space
 2017-03-13 06:55:07 -03:00
Adam Niederer
cb8fe92df7 Fix typo 2017-03-11 22:09:49 -05:00
Adam Niederer
7520377026 Spelling fixes 2017-03-11 21:38:50 -05:00
Adam Niederer
52d5fc713e Spelling fixes 2017-03-11 21:36:37 -05:00
Adam Niederer
867e2d69d4 Spelling, grammar, and style improvements 2017-03-11 21:35:00 -05:00
Adam Niederer
6d279f0ee1 Spelling fix 
Also removes an extra space
 2017-03-11 21:34:34 -05:00
Adam Niederer
a5e576c564 Grammar fix 2017-03-11 21:30:32 -05:00
Adam Niederer
eeb8e82771 Remove an extra space 2017-03-11 21:27:34 -05:00
Sjoerd Langkemper
d48395089c Update called from for two hooks 
`expressCreateServer` and `expressConfigure` are called from `express.js`, not
from `server.js`.
 2017-01-17 14:59:24 +01:00
Alexander Lorz
cd7f01f40a minor changes in docs 
- correct link to doc generation tool.
 - fixed incomplete sentence regarding API client libraries
 2016-12-26 20:18:34 +01:00
Luiza Pagliari
01d23b1f6a Merge pull request #2929 from xavidotron/develop 
Pass through the "item" parameter to registerAceCommand callbacks.
 2016-12-13 06:12:26 -02:00
Luc Didry
2341d09807 Add undocumented API function restoreRevision to doc 
This commit is dedicated to Schoumi. Thx for supporting me on Tipeee :-)
 2016-11-16 10:36:18 +01:00
John McLear
f09e10b122 Merge pull request #2944 from storytouch/aceRegisterNonScrollableEditEvents 
Create hook to register events that won't scroll editor after aceEditEvt
 2016-06-20 10:36:53 +01:00
Luiza Pagliari
69ac8e1722 Include usage example for aceRegisterNonScrollableEditEvents 2016-06-20 06:31:11 -03:00
Xavid
56b851a46f Pass through the "item" parameter to registerAceCommand callbacks. 2016-05-06 21:58:24 -04:00
Luiza Pagliari
3fb695a7a0 Create hook to register events that won't scroll editor after aceEditEvt 2016-03-30 11:51:18 -03:00
John McLear
4846798528 extend attributesonselection method 2016-03-26 22:00:34 +08:00
Ted Mielczarek
c70d655b96 Add appendText API (from #2810) to docs. 2016-01-13 07:26:20 -05:00
Mikk Andresen
4ad759dd25 Add postToolbarInit documentation and usage examples 2015-12-18 13:33:49 +02:00
Mikk Andresen
03a4828d31 Update aceEditorCSS hook documentation 2015-12-02 13:15:27 +02:00
Luiza Pagliari
92a8253449 Create hook exportHtmlAdditionalTagsWithData 
The new hook does the same as exportHtmlAdditionalTags, but is declared
in another hook to avoid confusion about how to export tags when they
are stored as ['tag', 'value'] on attribute pool.

This complements #2762, as per @Gared suggestions.
 2015-11-03 07:16:55 -02:00
John McLear
c337a0585c Merge pull request #2724 from xavidotron/develop 
Add a aceSelectionChanged hook to allow plugins to react when the cursor moves
 2015-10-22 16:19:07 +01:00
Stefan
504cc102a0 Merge pull request #2762 from storytouch/exportTagsAsArrays 
Accepting Arrays on 'exportHtmlAdditionalTags'
 2015-10-17 18:24:18 +02:00
Stefan
9d29b15def Merge pull request #2730 from emilyxxie/clientready_hook 
added clientReady hook
 2015-10-10 13:30:36 +02:00
Luiza Pagliari
1d134f0b13 Fixing ed52626. It was closing the span with </span data-TAG=VALUE>, not </span> 2015-09-17 15:30:09 -03:00
Luiza Pagliari
ed5262650a Generating pad HTML with tags like <span data-TAG="VALUE"> instead of <TAG:VALUE> 2015-09-07 03:55:56 -07:00
Luiza Pagliari
1a5985dc75 Accepting Arrays on 'exportHtmlAdditionalTags' to handle attributes stored as ['key', 'value'] (and not only ['key', 'true']) 2015-08-24 07:58:45 -07:00
Stefan
c8d7e6e0b8 Add appendChatMessage API to docs 2015-08-15 22:41:09 +02:00
Emily Xie
21f0d12d31 clientReady hook- pass entire message, updated doc 2015-07-20 11:45:41 -04:00
Xavid
008d4e653c Add a aceSelectionChanged hook to allow plugins to react when the cursor 
location changes.
 2015-07-11 11:33:20 -04:00
Xavid
bc78e0c68d Update documentation for the updatePad and createPad hooks to include 'author' 
in the context.
 2015-06-21 11:34:59 -04:00
John McLear
48da5c1ab1 docs for handle message security 2015-05-20 01:09:35 +01:00
Luiza Pagliari
6bd2013c71 Fixing documentation of collectContentPre 2015-05-15 11:18:58 -03:00
John McLear
b4163fc862 fix docs 2015-04-23 17:27:54 +01:00
John McLear
d31523aa08 Update hooks_server-side.md 2015-04-17 15:58:23 +01:00
John McLear
1d44490dc4 Merge pull request #2599 from Gared/doc_api_fix 
Fix documentation for deleteSession api method
 2015-04-11 15:07:18 +01:00
Stefan
a842eb4f5c Fix documentation for deleteSession api method 2015-04-11 16:05:41 +02:00
John McLear
84b3f1728f Merge pull request #2597 from Gared/increase_api_version 
increase http api version to latest version
 2015-04-11 14:56:47 +01:00
Stefan
d26c3d5f7e increase http api version 2015-04-11 13:45:59 +02:00
Stefan
601be46993 Add docs for new error message for createPad api method 2015-04-11 13:16:03 +02:00
Thomas Muehlichen
1e8e64d675 feature #2567 added documentation 2015-03-31 10:50:20 +02:00
Luc Didry
845788c39d Add a saveRevision API function 
Calling saveRevision create an author which name is "API"
 2015-02-25 01:04:27 +01:00
Luc Didry
a08c50a77d Fixes #1870 
Add two functions to API :
 * getSavedRevisionsCount
 * listSavedRevisions
 2015-02-24 23:42:35 +01:00
Luc Didry
4166f19078 Set correct API version in doc 
The doc says current version is 1.2.9, but there is getPadID which uses 1.2.10 API.
 2015-02-22 22:32:18 +01:00
John McLear
4de42da2e3 Merge pull request #2497 from ether/image-support-hook 
clean support for image hook
 2015-01-26 16:07:56 +00:00
John McLear
b8ac349b53 Update hooks_client-side.md 2015-01-26 16:07:46 +00:00
John McLear
2c3ce30fed docs 2015-01-26 02:42:48 +00:00
Stefan
4c64b7a670 Revert 'asyncLineHTMLForExport' hook 2015-01-25 22:08:40 +01:00
John McLear
378ed02269 docs 2015-01-24 13:30:03 +00:00
John McLear
4ecf0dfad2 docs for export HTML 2015-01-24 02:24:10 +00:00
John McLear
c878a957b7 fix issue in docs 2015-01-24 02:18:59 +00:00
John McLear
fccfc3bd41 docs 2014-12-09 16:16:19 +00:00
John McLear
b94a525e07 docs 2014-12-09 01:35:59 +00:00
John McLear
ce004f9c59 docs 2014-12-08 19:48:02 +00:00
John McLear
2218cbd252 docs 2014-12-08 19:08:12 +00:00
Simon Gaeremynck
2f8b860e69 Added a userLeave hook that gets called when a user leaves a pad 2014-08-08 15:49:15 +01:00
John McLear
44cb676ba2 Merge pull request #2150 from ether/export-file-name-hook 
Server side hook to modify the export file name
 2014-06-16 16:47:15 +01:00
Marcel Klehr
40a97f08bb Merge pull request #2169 from stephan48/develop 
Added documentation for the newly added API method getPadID
 2014-06-02 20:31:37 +02:00
Stephan Jauernick
bbd50dfc62 Added documentation for the newly added API method getPadID 2014-06-02 20:25:16 +02:00
David Cook
49114d2b7a Fix typos in easysync-full-description.tex 2014-06-01 23:57:20 -05:00
John McLear
d09e66e271 use call first and update docs 2014-05-12 15:08:32 +01:00
John McLear
a8d9a3868d docs for new hook 2014-05-06 21:22:03 +01:00