Release version 1.8.3

.dockerignore

@@ -1,3 +1,22 @@
 .hg
+
+# Remove the git objects, logs, etc. to make final image smaller.
+# Some files still need to be in the .git directory, because Etherpad at
+# startup uses them to discover its version number.
+.git/branches
+.git/COMMIT_EDITMSG
+.git/config
+.git/description
+.git/FETCH_HEAD
+.git/hooks
+.git/index
+.git/info
+.git/logs
+.git/objects
+.git/ORIG_HEAD
+.git/packed-refs
+.git/refs/remotes/
+.gitignore
+
 settings.json
 src/node_modules

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,46 @@
+* * *
+
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: 
+
+* * *
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+
+-   Etherpad Version: (e.g. 1.8.0)
+-   Deployment (manual install, docker, ...)
+
+**Desktop (please complete the following information):**
+
+-   OS: (e.g. iOS)
+-   Browser (e.g. chrome, safari)
+-   Version (e.g. 22)
+
+**Smartphone (please complete the following information):**
+
+-   Device: (e.g. iPhone6)
+-   OS: (e.g. iOS8.1)
+-   Browser (e.g. stock browser, safari)
+-   Version (e.g. 22)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+* * *
+
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: 
+
+* * *
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when (...)
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+<!--
+
+Some key notes before you open a PR:
+
+ 1. Select which branch should this PR be merged in? By default, you should always merge to the develop branch.
+ 2. PR name follows [convention](http://karma-runner.github.io/4.0/dev/git-commit-msg.html)
+ 3. All tests pass locally, UI and Unit tests
+ 4. All business logic and validations must be on the server-side
+ 5. Update necessary Documentation
+ 6. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes
+
+
+Also, if you're new here
+
+- Contribution Guide => https://github.com/ether/etherpad-lite/blob/master/CONTRIBUTING.md
+
+-->
+
+> Please provide enough information so that others can review your pull request:
+
+<!-- You can skip this if you're fixing a typo or updating existing documentation -->
+
+> Explain the **details** for making this change. What existing problem does the pull request solve?
+
+<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
+
+> Screenshots/GIFs
+
+<!-- Add images/recordings to better visualize the change: expected/current behviour -->

.gitignore

@@ -19,3 +19,6 @@ npm-debug.log
 bin/etherpad-1.deb
 credentials.json
 out/
+.nyc_output
+./package-lock.json
+.idea

.travis.yml

@@ -1,18 +1,49 @@
 language: node_js
+
 node_js:
   - "lts/*"
+
+services:
+  - docker
+
 install:
   - "bin/installDeps.sh"
   - "export GIT_HASH=$(git rev-parse --verify --short HEAD)"
   - "npm install ep_test_line_attrib"
+
+before_script:
+  - "tests/frontend/travis/sauce_tunnel.sh"
+
 script:
   - "tests/frontend/travis/runner.sh"
+
 env:
   global:
     - secure: "WMGxFkOeTTlhWB+ChMucRtIqVmMbwzYdNHuHQjKCcj8HBEPdZLfCuK/kf4rG\nVLcLQiIsyllqzNhBGVHG1nyqWr0/LTm8JRqSCDDVIhpyzp9KpCJQQJG2Uwjk\n6/HIJJh/wbxsEdLNV2crYU/EiVO3A4Bq0YTHUlbhUqG3mSCr5Ec="
     - secure: "gejXUAHYscbR6Bodw35XexpToqWkv2ifeECsbeEmjaLkYzXmUUNWJGknKSu7\nEUsSfQV8w+hxApr1Z+jNqk9aX3K1I4btL3cwk2trnNI8XRAvu1c1Iv60eerI\nkE82Rsd5lwUaMEh+/HoL8ztFCZamVndoNgX7HWp5J/NRZZMmh4g="
-jdk:
-  - oraclejdk6
+
+jobs:
+  include:
+    - name: "Run the Backend tests"
+      install:
+        - "cd src && npm install && cd -"
+      script:
+        - "tests/frontend/travis/runnerBackend.sh"
+    - name: "Test the Frontend"
+      install:
+        - "bin/installDeps.sh"
+        - "export GIT_HASH=$(git rev-parse --verify --short HEAD)"
+        - "npm install ep_test_line_attrib"
+      script:
+        - "tests/frontend/travis/runner.sh"
+    - name: "Test the Dockerfile"
+      install:
+        - "cd src && npm install && cd -"
+      script:
+        - "docker build -t etherpad:test ."
+        - "docker run -d -p 9001:9001 etherpad:test && sleep 3"
+        - "cd src && npm run test-container"
+
 notifications:
   irc:
     channels:

CHANGELOG.md

@@ -1,3 +1,29 @@
+# 1.8.3
+* FEATURE: colibris is now the default skin for new installs
+* FEATURE: improved colibris visuals, and migrated to Flexbox layout
+* FEATURE: skin variants: colibris skin colors can be easily customized. Visit http://127.0.0.1:9001/p/test#skinvariantsbuilder
+* REQUIREMENTS: minimum required Node version is **10.13.0 LTS**.
+* MINOR: stability fixes for the async migration in 1.8.0 (fixed many UnhandledPromiseRejectionWarning and the few remaining crashes)
+* MINOR: improved stability of import/export functionality
+* MINOR: fixed many small UI quirks (timeslider, import/export, chat)
+* MINOR: Docker images are now built & run in production mode by default
+* MINOR: reduced the size of the Docker images
+* MINOR: better documented cookies and configuration parameters of the Docker image
+* MINOR: better database support (especially MySQL)
+* MINOR: additional test coverage
+* MINOR: restored compatibility with ep_hash_auth
+* MINOR: migrate from swagger-node-express to openapi-backend
+* MINOR: honor the Accept-Language HTTP headers sent by browsers, eventually serving language variants
+* PERFORMANCE: correctly send HTTP/304 for minified files
+* SECURITY: bumped many dependencies. At the time of the release, this version has 0 reported vulnerabilities by npm audit
+* SECURITY: never send referrer when opening a link
+* SECURITY: rate limit imports and exports
+* SECURITY: do not allow pad import if a user never contributed to that pad
+* SECURITY: expose configuration parameter for limiting max import size
+
+*BREAKING CHANGE*: undoing the "clear authorship colors" command is no longer supported (see https://github.com/ether/etherpad-lite/issues/2802)
+*BREAKING CHANGE*: the visuals and CSS structure of the page was updated. Plugins may need a CSS rehaul
+
 # 1.8
 * SECURITY: change referrer policy so that Etherpad addresses aren't leaked when links are clicked (discussion: https://github.com/ether/etherpad-lite/pull/3636)
 * SECURITY: set the "secure" flag for the session cookies when served over SSL. From now on it will not be possible to serve the same instance both in cleartext and over SSL

Dockerfile

@@ -15,23 +15,24 @@ LABEL maintainer="Etherpad team, https://github.com/ether/etherpad-lite"
 #   ETHERPAD_PLUGINS="ep_codepad ep_author_neat"
 ARG ETHERPAD_PLUGINS=
 
-# Set the following to production to avoid installing devDeps
-# this can be done with build args (and is mandatory to build ARM version)
-ENV NODE_ENV=development
+# By default, Etherpad container is built and run in "production" mode. This is
+# leaner (development dependencies are not installed) and runs faster (among
+# other things, assets are minified & compressed).
+ENV NODE_ENV=production
 
 # Follow the principle of least privilege: run as unprivileged user.
 #
 # Running as non-root enables running this image in platforms like OpenShift
 # that do not allow images running as root.
 RUN useradd --uid 5001 --create-home etherpad
 
-RUN mkdir /opt/etherpad-lite && chown etherpad:etherpad /opt/etherpad-lite
+RUN mkdir /opt/etherpad-lite && chown etherpad:0 /opt/etherpad-lite
 
-USER etherpad:etherpad
+USER etherpad
 
 WORKDIR /opt/etherpad-lite
 
-COPY --chown=etherpad:etherpad ./ ./
+COPY --chown=etherpad:0 ./ ./
 
 # install node dependencies for Etherpad
 RUN bin/installDeps.sh && \
@@ -44,7 +45,10 @@ RUN bin/installDeps.sh && \
 RUN for PLUGIN_NAME in ${ETHERPAD_PLUGINS}; do npm install "${PLUGIN_NAME}"; done
 
 # Copy the configuration file.
-COPY --chown=etherpad:etherpad ./settings.json.docker /opt/etherpad-lite/settings.json
+COPY --chown=etherpad:0 ./settings.json.docker /opt/etherpad-lite/settings.json
+
+# Fix permissions for root group
+RUN chmod -R g=u .
 
 EXPOSE 9001
 CMD ["node", "node_modules/ep_etherpad-lite/node/server.js"]

Makefile

@@ -6,7 +6,14 @@ docassets = $(addprefix out/,$(wildcard doc/assets/*))
 VERSION = $(shell node -e "console.log( require('./src/package.json').version )")
 UNAME := $(shell uname -s)
 
-docs: $(outdoc_files) $(docassets)
+ensure_marked_is_installed:
+	set -eu; \
+	hash npm; \
+	if [ $(shell npm list --prefix bin/doc >/dev/null 2>/dev/null; echo $$?) -ne "0" ]; then \
+		npm ci --prefix=bin/doc; \
+	fi
+
+docs: ensure_marked_is_installed $(outdoc_files) $(docassets)
 
 out/doc/assets/%: doc/assets/%
 	mkdir -p $(@D)

README.md

@@ -1,16 +1,17 @@
 # A real-time collaborative editor for the web
 <a href="https://hub.docker.com/r/etherpad/etherpad"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/etherpad/etherpad"></a>
-![Demo Etherpad Animated Jif](https://i.imgur.com/zYrGkg3.gif "Etherpad in action")
+[![Travis (.org)](https://img.shields.io/travis/ether/etherpad-lite)](https://travis-ci.org/github/ether/etherpad-lite)
+![Demo Etherpad Animated Jif](doc/images/etherpad_demo.gif "Etherpad in action")
 
 # About
 Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on _your_ server, under _your_ control.
 
-**[Try it out](https://beta.etherpad.org)**
+**[Try it out](https://video.etherpad.com)**
 
 # Installation
 
 ## Requirements
-- `nodejs` >= **8.9.0** (preferred: `nodejs` >= **10.13.0**). Please note that starting Jan 1st, 2020, nodejs 8.x is deprecated.
+- `nodejs` >= **10.13.0**.
 
 ## GNU/Linux and other UNIX-like systems
 
@@ -22,7 +23,7 @@ git clone --branch master https://github.com/ether/etherpad-lite.git && cd ether
 ```
 
 ### Manual install
-You'll need git and [node.js](https://nodejs.org) installed (minimum required Node version: **8.9.0**, preferred: >= **10.13.0**).
+You'll need git and [node.js](https://nodejs.org) installed (minimum required Node version: **10.13.0**).
 
 **As any user (we recommend creating a separate user called etherpad):**
 
@@ -50,7 +51,7 @@ You'll need [node.js](https://nodejs.org) and (optionally, though recommended) g
 1. Grab the source, either
   - download <https://github.com/ether/etherpad-lite/zipball/master>
   - or `git clone --branch master https://github.com/ether/etherpad-lite.git`
-2. start `bin\installOnWindows.bat`
+2. With a "Run as administrator" command prompt execute `bin\installOnWindows.bat`
 
 Now, run `start.bat` and open <http://localhost:9001> in your browser.
 
@@ -83,10 +84,20 @@ If you have enabled authentication in `users` section in `settings.json`, it is
 Please install [ep_hash_auth plugin](https://www.npmjs.com/package/ep_hash_auth) and configure it.
 If you prefer, `ep_hash_auth` also gives you the option of storing the users in a custom directory in the file system, without having to edit `settings.json` and restart Etherpad each time.
 
-## Plugins and themes
+## Customize functionalities with plugins
+
+![Basic install](doc/images/etherpad_basic.png "Basic Installation")
+
+![Full Features](doc/images/etherpad_full_features.png "You can add a lot of plugins !")
 
 Etherpad is very customizable through plugins. Instructions for installing themes and plugins can be found in [the plugin wiki article](https://github.com/ether/etherpad-lite/wiki/Available-Plugins).
 
+## Customize the style with skin variants
+
+Open <http://127.0.0.1:9001/p/test#skinvariantsbuilder> in your browser and start playing !
+
+![Skin Variant](doc/images/etherpad_skin_variants.gif "Skin variants")
+
 ## Helpful resources
 The [wiki](https://github.com/ether/etherpad-lite/wiki) is your one-stop resource for Tutorials and How-to's.
 
@@ -97,6 +108,8 @@ Documentation can be found in `doc/`.
 ## Things you should know
 You can debug Etherpad using `bin/debugRun.sh`.
 
+You can run Etherpad quickly launching `bin/fastRun.sh`. It's convenient for developers and advanced users. Be aware that it will skip the dependencies update, so remember to run `bin/installDeps.sh` after installing a new dependency or upgrading version.
+
 If you want to find out how Etherpad's `Easysync` works (the library that makes it really realtime), start with this [PDF](https://github.com/ether/etherpad-lite/raw/master/doc/easysync/easysync-full-description.pdf) (complex, but worth reading).
 
 ## Contributing
@@ -111,6 +124,8 @@ For **responsible disclosure of vulnerabilities**, please write a mail to the ma
 Etherpad is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API)
 that allows your web application to manage pads, users and groups. It is recommended to use the [available client implementations](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries) in order to interact with this API.
 
+OpenAPI (previously swagger) definitions for the API are exposed under `/api/openapi.json`.
+
 # jQuery plugin
 There is a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website.
 

bin/buildDebian.sh

@@ -24,7 +24,7 @@ find ${SRC}/ -type d -exec chmod 0755 {} \;
 find ${SRC}/ -type f -exec chmod go-w {} \;
 chown -R root:root ${SRC}/
 
-let SIZE=`du -s ${SYSROOT} | sed s'/\s\+.*//'`+8
+let SIZE=$(du -s ${SYSROOT} | sed s'/\s\+.*//')+8
 pushd ${SYSROOT}/
 tar czf ${DIST}/data.tar.gz [a-z]*
 popd

bin/buildForWindows.sh

@@ -1,9 +1,9 @@
 #!/bin/sh
 
-NODE_VERSION="10.16.3"
+NODE_VERSION="10.20.1"
 
 #Move to the folder where ep-lite is installed
-cd `dirname $0`
+cd $(dirname $0)
 
 #Was this script started in the bin folder? if yes move out
 if [ -d "../bin" ]; then