.dockerignore

@@ -1,26 +0,0 @@
-*~
-.dockerignore
-.hg
-Dockerfile
-
-# 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/
-.git/rr-cache/
-.gitignore
-
-settings.json
-src/node_modules

.gitattributes

@@ -1 +0,0 @@
-* text=auto eol=lf

.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: ether

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,47 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!-- IMPORTANT: Please disable plugins prior to posting a bug report.  If you have a problem with a plugin please post on the plugin repository.  Thanks! -->
-
-**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.
-
-**Server (please complete the following information):**
- - Etherpad version:
- - OS: [e.g., Ubuntu 20.04]
- - Node.js version (`node --version`):
- - npm version (`npm --version`):
- - Is the server free of plugins: 
-
-**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

@@ -1,33 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: Feature Request
-assignees: ''
-
----
-
-* * *
-
-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.
-
-**Plugin?**
-Might this feature be better suited to being a plugin?  Usually features that can be plugins, should be.

.github/ISSUE_TEMPLATE/plugin-request-template.md

@@ -1,30 +0,0 @@
----
-name: Plugin request template
-about: Suggest a plugin for Etherpad
-title: ''
-labels: Plugin Request
-assignees: JohnMcLear
-
----
-
-* * *
-
-name: Plugin request
-about: Suggest a plugin for this project
-title: ''
-labels: plugin request
-assignees: 
-
-* * *
-
-**Is your plugin 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 plugin request here.

.github/ISSUE_TEMPLATE/security-issue.md

@@ -1,10 +0,0 @@
----
-name: Security issue
-about: Notify the Etherpad foundation of a Security issue
-title: ''
-labels: security
-assignees: ''
-
----
-
-Please email contact@etherpad.org with details of the security issue prior to posting here.

.github/ISSUE_TEMPLATE/security.md

@@ -1,13 +0,0 @@
-* * *
-
-name: Security notification
-about: Disclose a security issue in Etherpad
-title: ''
-labels: security
-assignees: 
-
-* * *
-
-**Our Security disclosure process**
-1. Please email contact@etherpad.org with detials of the exploit including steps to replicate.
-1. Once confirmed we will provide a confirmation, patch and CVE details.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,13 +0,0 @@
-<!--
-
-1. If you haven't already, please read https://github.com/ether/etherpad-lite/blob/master/CONTRIBUTING.md#pull-requests .
-2. Run all the tests, both front-end and back-end.  (see https://github.com/ether/etherpad-lite/blob/master/CONTRIBUTING.md#testing)
-3. Keep business logic and validation on the server-side.
-4. Update documentation.
-5. Write `fixes #XXXX` in your comment to auto-close an issue.
-
-If you're making a big change, please explain what problem it solves:
-- Explain the purpose of the change.  When adding a way to do X, explain why it is important to be able to do X.
-- Show the current vs desired behavior with screenshots/GIFs.
-
--->

.github/dependabot.yml

@@ -1,21 +0,0 @@
-version: 2
-updates:
-  # Maintain dependencies for GitHub Actions
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "docker"
-    directory: "/"
-    schedule:
-      interval: "daily"
-  - package-ecosystem: "npm"
-    directory: "/src"
-    schedule:
-      interval: "daily"
-    versioning-strategy: "increase"
-  - package-ecosystem: "npm"
-    directory: "/src/bin/doc"
-    schedule:
-      interval: "daily"
-    versioning-strategy: "increase"

.github/workflows/backend-tests.yml

@@ -1,203 +0,0 @@
-name: "Backend tests"
-
-# any branch is useful for testing before a PR is submitted
-on: [push, pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  withoutpluginsLinux:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Linux without plugins
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        node: [16, 18, 20]
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install libreoffice
-        run: |
-          sudo add-apt-repository -y ppa:libreoffice/ppa
-          sudo apt update
-          sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Run the backend tests
-        run: cd src && npm test
-
-  withpluginsLinux:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Linux with Plugins
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        node: [16, 18, 20]
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install libreoffice
-        run: |
-          sudo add-apt-repository -y ppa:libreoffice/ppa
-          sudo apt update
-          sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
-      -
-        name: Install Etherpad plugins
-        # The --legacy-peer-deps flag is required to work around a bug in npm v7:
-        # https://github.com/npm/cli/issues/2199
-        run: >
-          npm install --no-save --legacy-peer-deps
-          ep_align
-          ep_author_hover
-          ep_cursortrace
-          ep_font_size
-          ep_hash_auth
-          ep_headings2
-          ep_image_upload
-          ep_markdown
-          ep_readonly_guest
-          ep_set_title_on_pad
-          ep_spellcheck
-          ep_subscript_and_superscript
-          ep_table_of_contents
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Run the backend tests
-        run: cd src && npm test
-
-  withoutpluginsWindows:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Windows without plugins
-    runs-on: windows-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installOnWindows.bat
-      -
-        name:  Fix up the settings.json
-        run: |
-          powershell -Command "(gc settings.json.template) -replace '\"max\": 10', '\"max\": 10000' | Out-File -encoding ASCII settings.json.holder"
-          powershell -Command "(gc settings.json.holder) -replace '\"points\": 10', '\"points\": 1000' | Out-File -encoding ASCII settings.json"
-      -
-        name: Run the backend tests
-        run: cd src && npm test
-
-  withpluginsWindows:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Windows with Plugins
-    runs-on: windows-latest
-
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install Etherpad plugins
-        # The --legacy-peer-deps flag is required to work around a bug in npm
-        # v7: https://github.com/npm/cli/issues/2199
-        run: >
-          npm install --no-save --legacy-peer-deps
-          ep_align
-          ep_author_hover
-          ep_cursortrace
-          ep_font_size
-          ep_hash_auth
-          ep_headings2
-          ep_image_upload
-          ep_markdown
-          ep_readonly_guest
-          ep_set_title_on_pad
-          ep_spellcheck
-          ep_subscript_and_superscript
-          ep_table_of_contents
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installOnWindows.bat
-      -
-        name:  Fix up the settings.json
-        run: |
-          powershell -Command "(gc settings.json.template) -replace '\"max\": 10', '\"max\": 10000' | Out-File -encoding ASCII settings.json.holder"
-          powershell -Command "(gc settings.json.holder) -replace '\"points\": 10', '\"points\": 1000' | Out-File -encoding ASCII settings.json"
-      -
-        name: Run the backend tests
-        run: cd src && npm test

.github/workflows/codeql-analysis.yml

@@ -1,44 +0,0 @@
-name: "CodeQL"
-
-on:
-  push:
-    branches: [develop, master]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [develop]
-  schedule:
-    - cron: '0 13 * * 1'
-
-permissions:
-  contents: read
-
-jobs:
-  analyze:
-    permissions:
-      actions: read  # for github/codeql-action/init to get workflow details
-      contents: read  # for actions/checkout to fetch code
-      security-events: write  # for github/codeql-action/autobuild to send a status report
-    name: Analyze
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          # We must fetch at least the immediate parents so that if this is
-          # a pull request then we can checkout the head.
-          fetch-depth: 2
-      # If this run was triggered by a pull request event, then checkout
-      # the head of the pull request instead of the merge commit.
-      -
-        run: git checkout HEAD^2
-        if: ${{ github.event_name == 'pull_request' }}
-      -
-        name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
-      -
-        name: Autobuild
-        uses: github/codeql-action/autobuild@v2
-      -
-        name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2

.github/workflows/dependency-review.yml

@@ -1,20 +0,0 @@
-# Dependency Review Action
-#
-# This Action will scan dependency manifest files that change as part of a Pull Reqest, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
-#
-# Source repository: https://github.com/actions/dependency-review-action
-# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
-name: 'Dependency Review'
-on: [pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  dependency-review:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Checkout Repository'
-        uses: actions/checkout@v4
-      - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3

.github/workflows/docker.yml

@@ -1,91 +0,0 @@
-name: Docker
-on:
-  pull_request:
-  push:
-    branches:
-      - 'develop'
-    tags:
-      - 'v?[0-9]+.[0-9]+.[0-9]+'
-env:
-  TEST_TAG: etherpad/etherpad:test
-permissions:
-  contents: read
-
-jobs:
-  docker:
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Check out
-        uses: actions/checkout@v4
-      -
-        name: Set up QEMU
-        if: github.event_name == 'push'
-        uses: docker/setup-qemu-action@v3
-      -
-        name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-      -
-        name: Build and export to Docker
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          load: true
-          tags: ${{ env.TEST_TAG }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-      -
-        name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Test
-        run: |
-          docker run --rm -d -p 9001:9001 --name test ${{ env.TEST_TAG }}
-          docker logs -f test &
-          ./src/bin/installDeps.sh
-          while true; do
-            echo "Waiting for Docker container to start..."
-            status=$(docker container inspect -f '{{.State.Health.Status}}' test) || exit 1
-            case ${status} in
-              healthy) break;;
-              starting) sleep 2;;
-              *) printf %s\\n "unexpected status: ${status}" >&2; exit 1;;
-            esac
-          done
-          (cd src && npm run test-container)
-          git clean -dxf .
-      -
-        name: Docker meta
-        if: github.event_name == 'push'
-        id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: etherpad/etherpad
-          tags: |
-            type=ref,event=branch
-            type=semver,pattern={{version}}
-            type=semver,pattern={{major}}.{{minor}}
-            type=semver,pattern={{major}}
-      -
-        name: Log in to Docker Hub
-        if: github.event_name == 'push'
-        uses: docker/login-action@v3
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      -
-        name: Build and push
-        if: github.event_name == 'push'
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          platforms: linux/amd64,linux/arm64
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/frontend-admin-tests.yml

@@ -1,96 +0,0 @@
-# Leave the powered by Sauce Labs bit in as this means we get additional concurrency
-name: "Frontend admin tests powered by Sauce Labs"
-
-on: [push]
-
-permissions:
-  contents: read # to fetch code (actions/checkout)
-
-jobs:
-  withplugins:
-    if: ${{ github.actor != 'dependabot[bot]' }}
-    name: with plugins
-    runs-on: ubuntu-latest
-
-#        node: [16, 19, 20] >> Disabled node 16 and 18 because they do not work
-    strategy:
-      fail-fast: false
-      matrix:
-        node: [19, 20]
-
-    steps:
-      -
-        name: Generate Sauce Labs strings
-        id: sauce_strings
-        run: |
-          printf %s\\n '::set-output name=name::${{ github.workflow }} - ${{ github.job }} - Node ${{ matrix.node }}'
-          printf %s\\n '::set-output name=tunnel_id::${{ github.run_id }}-${{ github.run_number }}-${{ github.job }}-node${{ matrix.node }}'
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install etherpad plugins
-        # We intentionally install an old ep_align version to test upgrades to
-        # the minor version number. The --legacy-peer-deps flag is required to
-        # work around a bug in npm v7: https://github.com/npm/cli/issues/2199
-        run: npm install --no-save --legacy-peer-deps ep_align@0.2.27
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Install etherpad plugins
-        run: rm -Rf node_modules/ep_align/static/tests/*
-      -
-        name: export GIT_HASH to env
-        id: environment
-        run: echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
-      -
-        name: Create settings.json
-        run: cp settings.json.template settings.json
-      -
-        name: Write custom settings.json that enables the Admin UI tests
-        run: "sed -i 's/\"enableAdminUITests\": false/\"enableAdminUITests\": true,\\n\"users\":{\"admin\":{\"password\":\"changeme\",\"is_admin\":true}}/' settings.json"
-      -
-        name: increase maxHttpBufferSize
-        run: "sed -i 's/\"maxHttpBufferSize\": 10000/\"maxHttpBufferSize\": 100000/' settings.json"
-      -
-        name: Disable import/export rate limiting
-        run: |
-          sed -e '/^ *"importExportRateLimiting":/,/^ *\}/ s/"max":.*/"max": 1000000/' -i settings.json
-      -
-        name: Remove standard frontend test files, so only admin tests are run
-        run: mv src/tests/frontend/specs/* /tmp && mv /tmp/admin*.js src/tests/frontend/specs
-      -
-        uses: saucelabs/sauce-connect-action@v2.3.5
-        with:
-          username: ${{ secrets.SAUCE_USERNAME }}
-          accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
-          tunnelIdentifier: ${{ steps.sauce_strings.outputs.tunnel_id }}
-      -
-        name: Run the frontend admin tests
-        shell: bash
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
-          SAUCE_NAME: ${{ steps.sauce_strings.outputs.name }}
-          TRAVIS_JOB_NUMBER: ${{ steps.sauce_strings.outputs.tunnel_id }}
-          GIT_HASH: ${{ steps.environment.outputs.sha_short }}
-        run: |
-          src/tests/frontend/travis/adminrunner.sh

.github/workflows/frontend-tests.yml

@@ -1,151 +0,0 @@
-# Leave the powered by Sauce Labs bit in as this means we get additional concurrency
-name: "Frontend tests powered by Sauce Labs"
-
-on: [push]
-
-permissions:
-  contents: read # to fetch code (actions/checkout)
-
-jobs:
-  withoutplugins:
-    name: without plugins
-    runs-on: ubuntu-latest
-    if: ${{ github.actor != 'dependabot[bot]' }}
-
-    steps:
-      -
-        name: Generate Sauce Labs strings
-        id: sauce_strings
-        run: |
-          printf %s\\n '::set-output name=name::${{ github.workflow }} - ${{ github.job }}'
-          printf %s\\n '::set-output name=tunnel_id::${{ github.run_id }}-${{ github.run_number }}-${{ github.job }}'
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: export GIT_HASH to env
-        id: environment
-        run: echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
-      -
-        name: Create settings.json
-        run: cp settings.json.template settings.json
-      -
-        name: Disable import/export rate limiting
-        run: |
-          sed -e '/^ *"importExportRateLimiting":/,/^ *\}/ s/"max":.*/"max": 100000000/' -i settings.json
-      -
-        uses: saucelabs/sauce-connect-action@v2.3.5
-        with:
-          username: ${{ secrets.SAUCE_USERNAME }}
-          accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
-          tunnelIdentifier: ${{ steps.sauce_strings.outputs.tunnel_id }}
-      -
-        name: Run the frontend tests
-        shell: bash
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
-          SAUCE_NAME: ${{ steps.sauce_strings.outputs.name }}
-          TRAVIS_JOB_NUMBER: ${{ steps.sauce_strings.outputs.tunnel_id }}
-          GIT_HASH: ${{ steps.environment.outputs.sha_short }}
-        run: |
-          src/tests/frontend/travis/runner.sh
-
-  withplugins:
-    name: with plugins
-    runs-on: ubuntu-latest
-    if: ${{ github.actor != 'dependabot[bot]' }}
-
-    steps:
-      -
-        name: Generate Sauce Labs strings
-        id: sauce_strings
-        run: |
-          printf %s\\n '::set-output name=name::${{ github.workflow }} - ${{ github.job }}'
-          printf %s\\n '::set-output name=tunnel_id::${{ github.run_id }}-${{ github.run_number }}-${{ github.job }}'
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install Etherpad plugins
-        # The --legacy-peer-deps flag is required to work around a bug in npm v7:
-        # https://github.com/npm/cli/issues/2199
-        run: >
-          npm install --no-save --legacy-peer-deps
-          ep_align
-          ep_author_hover
-          ep_cursortrace
-          ep_embedmedia
-          ep_font_size
-          ep_hash_auth
-          ep_headings2
-          ep_image_upload
-          ep_markdown
-          ep_readonly_guest
-          ep_set_title_on_pad
-          ep_spellcheck
-          ep_subscript_and_superscript
-          ep_table_of_contents
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.20.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: export GIT_HASH to env
-        id: environment
-        run: echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
-      -
-        name: Create settings.json
-        run: cp settings.json.template settings.json
-      -
-        name: Disable import/export rate limiting
-        run: |
-          sed -e '/^ *"importExportRateLimiting":/,/^ *\}/ s/"max":.*/"max": 1000000/' -i settings.json
-      # XXX we should probably run all tests, because plugins could effect their results
-      -
-        name: Remove standard frontend test files, so only plugin tests are run
-        run: rm src/tests/frontend/specs/*
-      -
-        uses: saucelabs/sauce-connect-action@v2.3.5
-        with:
-          username: ${{ secrets.SAUCE_USERNAME }}
-          accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
-          tunnelIdentifier: ${{ steps.sauce_strings.outputs.tunnel_id }}
-      -
-        name: Run the frontend tests
-        shell: bash
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
-          SAUCE_NAME: ${{ steps.sauce_strings.outputs.name }}
-          TRAVIS_JOB_NUMBER: ${{ steps.sauce_strings.outputs.tunnel_id }}
-          GIT_HASH: ${{ steps.environment.outputs.sha_short }}
-        run: |
-          src/tests/frontend/travis/runner.sh

.github/workflows/lint-package-lock.yml

@@ -1,41 +0,0 @@
-name: "Lint"
-
-# any branch is useful for testing before a PR is submitted
-on: [push, pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  lint-package-lock:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: package-lock.json
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install lockfile-lint
-        run: npm install --no-save lockfile-lint --legacy-peer-deps
-      -
-        name: Run lockfile-lint on package-lock.json
-        run: >
-          npx lockfile-lint
-          --path src/package-lock.json
-          --allowed-hosts npm
-          --allowed-schemes https:
-          --allowed-schemes github:
-          --allowed-urls github:mapbox/node-sqlite3#593c9d498be2510d286349134537e3bf89401c4a

.github/workflows/load-test.yml

@@ -1,125 +0,0 @@
-name: "Loadtest"
-
-# any branch is useful for testing before a PR is submitted
-on: [push, pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  withoutplugins:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: without plugins
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Install etherpad-load-test
-        run: sudo npm install -g etherpad-load-test
-      -
-        name: Run load test
-        run: src/tests/frontend/travis/runnerLoadTest.sh 25 50
-
-  withplugins:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: with Plugins
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install etherpad-load-test
-        run: sudo npm install -g etherpad-load-test
-      -
-        name: Install etherpad plugins
-        # The --legacy-peer-deps flag is required to work around a bug in npm v7:
-        # https://github.com/npm/cli/issues/2199
-        run: >
-          npm install --no-save --legacy-peer-deps
-          ep_align
-          ep_author_hover
-          ep_cursortrace
-          ep_font_size
-          ep_hash_auth
-          ep_headings2
-          ep_markdown
-          ep_readonly_guest
-          ep_set_title_on_pad
-          ep_spellcheck
-          ep_subscript_and_superscript
-          ep_table_of_contents
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Run load test
-        run: src/tests/frontend/travis/runnerLoadTest.sh 25 50
-
-  long:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: long running
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Install etherpad-load-test
-        run: sudo npm install -g etherpad-load-test
-      -
-        name: Run load test
-        run: src/tests/frontend/travis/runnerLoadTest.sh 5000 5

.github/workflows/rate-limit.yml

@@ -1,52 +0,0 @@
-name: "rate limit"
-
-# any branch is useful for testing before a PR is submitted
-on: [push, pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  ratelimit:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: test
-    runs-on: ubuntu-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: docker network
-        run: docker network create --subnet=172.23.42.0/16 ep_net
-      -
-        name: build docker image
-        run: |
-          docker build -f Dockerfile -t epl-debian-slim .
-          docker build -f src/tests/ratelimit/Dockerfile.nginx -t nginx-latest .
-          docker build -f src/tests/ratelimit/Dockerfile.anotherip -t anotherip .
-      -
-        name: run docker images
-        run: |
-          docker run --name etherpad-docker -p 9000:9001 --rm --network ep_net --ip 172.23.42.2 -e 'TRUST_PROXY=true' epl-debian-slim &
-          docker run -p 8081:80 --rm --network ep_net --ip 172.23.42.1 -d nginx-latest
-          docker run --rm --network ep_net --ip 172.23.42.3 --name anotherip -dt anotherip
-      -
-        name: install dependencies and create symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: run rate limit test
-        run: |
-          cd src/tests/ratelimit
-          ./testlimits.sh

.github/workflows/stale.yml

@@ -1,18 +0,0 @@
-name: 'Close stale issues and PRs'
-on:
-  schedule:
-    - cron: '30 6 * * *'
-permissions:
-  issues: write
-  pull-requests: write
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v8
-        with:
-          close-issue-label: wontfix
-          close-pr-label: wontfix
-          days-before-close: -1
-          exempt-issue-labels: 'pinned,security,Bug,Serious Bug,Minor bug,Black hole bug,Special case Bug,Upstream bug,Feature Request'
-          exempt-pr-labels: 'pinned,security,Bug,Serious Bug,Minor bug,Black hole bug,Special case Bug,Upstream bug,Feature Request'

.github/workflows/upgrade-from-latest-release.yml

@@ -1,99 +0,0 @@
-name: "Upgrade from latest release"
-
-# any branch is useful for testing before a PR is submitted
-on: [push, pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  withpluginsLinux:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Linux with Plugins
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        node: [16, 18, 20]
-    steps:
-      -
-        name: Check out latest release
-        uses: actions/checkout@v4
-        with:
-          ref: master
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install Etherpad plugins
-        # The --legacy-peer-deps flag is required to work around a bug in npm
-        # v7: https://github.com/npm/cli/issues/2199
-        run: >
-          npm install --no-save --legacy-peer-deps
-          ep_align
-          ep_author_hover
-          ep_cursortrace
-          ep_font_size
-          ep_hash_auth
-          ep_headings2
-          ep_image_upload
-          ep_markdown
-          ep_readonly_guest
-          ep_set_title_on_pad
-          ep_spellcheck
-          ep_subscript_and_superscript
-          ep_table_of_contents
-      # Etherpad core dependencies must be installed after installing the
-      # plugin's dependencies, otherwise npm will try to hoist common
-      # dependencies by removing them from src/node_modules and installing them
-      # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
-      # to be buggy, because it sometimes removes dependencies from
-      # src/node_modules but fails to add them to the top-level node_modules.
-      # Even if npm correctly hoists the dependencies, the hoisting seems to
-      # confuse tools such as `npm outdated`, `npm update`, and some ESLint
-      # rules.
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Run the backend tests
-        run: cd src && npm test
-      # Because actions/checkout@v4 is called with "ref: master" and without
-      # "fetch-depth: 0", the local clone does not have the ${GITHUB_SHA}
-      # commit. Fetch ${GITHUB_REF} to get the ${GITHUB_SHA} commit. Note that a
-      # plain "git fetch" only fetches "normal" references (refs/heads/* and
-      # refs/tags/*), and for pull requests none of the normal references
-      # include ${GITHUB_SHA}, so we have to explicitly tell Git to fetch
-      # ${GITHUB_REF}.
-      -
-        name: Fetch the new Git commits
-        run: git fetch --depth=1 origin "${GITHUB_REF}"
-      -
-        name: Upgrade to the new Git revision
-        # For pull requests, ${GITHUB_SHA} is the automatically generated merge
-        # commit that merges the PR's source branch to its destination branch.
-        run: git checkout "${GITHUB_SHA}"
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        run: src/bin/installDeps.sh
-      -
-        name: Run the backend tests
-        run: cd src && npm test
-      -
-        name: Install Cypress
-        run: cd src && npm install cypress --legacy-peer-deps
-      -
-        name: Run Etherpad & Test Frontend
-        run: |
-          node src/node/server.js &
-          curl --connect-timeout 10 --max-time 20 --retry 5 --retry-delay 10 --retry-max-time 60 --retry-connrefused http://127.0.0.1:9001/p/test
-          ./src/node_modules/cypress/bin/cypress run --config-file src/tests/frontend/cypress/cypress.config.js

.github/workflows/windows.yml

@@ -1,135 +0,0 @@
-name: "Windows Build"
-
-# any branch is useful for testing before a PR is submitted
-on: [push, pull_request]
-
-permissions:
-  contents: read
-
-jobs:
-  build-zip:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Build .zip
-    runs-on: windows-latest
-    steps:
-      -
-        uses: msys2/setup-msys2@v2
-        with:
-          path-type: inherit
-          install: >-
-            zip
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            src/package-lock.json
-            src/bin/doc/package-lock.json
-      -
-        name: Install all dependencies and symlink for ep_etherpad-lite
-        shell: msys2 {0}
-        run: src/bin/installDeps.sh
-      -
-        name: Run the backend tests
-        shell: msys2 {0}
-        run: cd src && npm test
-      -
-        name: Build the .zip
-        shell: msys2 {0}
-        run: src/bin/buildForWindows.sh
-      -
-        name: Archive production artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: etherpad-win.zip
-          path: etherpad-win.zip
-
-  build-exe:
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Build .exe
-    needs: build-zip
-    runs-on: windows-latest
-    steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        name: Download .zip
-        uses: actions/download-artifact@v3
-        with:
-          name: etherpad-win.zip
-          path: ..
-      -
-        name: Extract .zip
-        working-directory: ..
-        run: 7z x etherpad-win.zip -oetherpad-zip
-      -
-        name: Create installer
-        uses: joncloud/makensis-action@v3.7
-        with:
-          script-file: 'src/bin/nsis/etherpad.nsi'
-      -
-        name: Archive production artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: etherpad-win.exe
-          path: etherpad-win.exe
-
-  deploy-zip:
-    # run on pushes to any branch
-    # run on PRs from external forks
-    permissions:
-      contents: write
-    if: |
-      (github.event_name != 'pull_request')
-      || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
-    name: Deploy
-    needs: build-zip
-    runs-on: windows-latest
-    steps:
-      -
-        name: Download zip
-        uses: actions/download-artifact@v3
-        with:
-          name: etherpad-win.zip
-      -
-        name: Extract Etherpad
-        run: 7z x etherpad-win.zip -oetherpad
-      -
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: 'npm'
-          cache-dependency-path: |
-            etherpad/src/package-lock.json
-            etherpad/src/bin/doc/package-lock.json
-      -
-        name: Install Cypress
-        run: cd etherpad && cd src && npm install cypress --legacy-peer-deps
-      -
-        name: Run Etherpad
-        run: |
-          cd etherpad
-          node node_modules\ep_etherpad-lite\node\server.js &
-          curl --connect-timeout 10 --max-time 20 --retry 5 --retry-delay 10 --retry-max-time 60 --retry-connrefused http://127.0.0.1:9001/p/test
-          src\node_modules\cypress\bin\cypress run --config-file src\tests\frontendcypress\cypress.config.js
-      # On release, upload windows zip to GitHub release tab
-      -
-        name: Rename to etherpad-lite-win.zip
-        shell: powershell
-        run: mv etherpad-win.zip etherpad-lite-win.zip
-      - name: upload binaries to release
-        uses: softprops/action-gh-release@v1
-        if: ${{startsWith(github.ref, 'refs/tags/v') }}
-        with:
-            files: etherpad-lite-win.zip

.gitignore

@@ -1,23 +1,14 @@
-/etherpad-win.exe
-/etherpad-win.zip
 node_modules
-/settings.json
-!settings.json.template
+settings.json
 APIKEY.txt
-SESSIONKEY.txt
+bin/abiword.exe
+bin/node.exe
+etherpad-lite-win.zip
 var/dirty.db
+bin/convertSettings.json
 *~
 *.patch
+src/static/js/jquery.js
 npm-debug.log
 *.DS_Store
-*.crt
-*.key
-credentials.json
-out/
-.nyc_output
-.idea
-/package-lock.json
-/src/bin/abiword.exe
-/src/bin/convertSettings.json
-/src/bin/etherpad-1.deb
-/src/bin/node.exe
+.ep_initialized

.lgtm.yml

@@ -1,9 +0,0 @@
-extraction:
-  javascript:
-    index:
-      exclude:
-        - src/static/js/vendors
-  python:
-    index:
-      exclude:
-        - /

.travis.yml

@@ -1,145 +0,0 @@
-language: node_js
-
-node_js:
-  - "lts/*"
-
-services:
-  - docker
-
-cache: false
-
-env:
-  global:
-    - secure: "WMGxFkOeTTlhWB+ChMucRtIqVmMbwzYdNHuHQjKCcj8HBEPdZLfCuK/kf4rG\nVLcLQiIsyllqzNhBGVHG1nyqWr0/LTm8JRqSCDDVIhpyzp9KpCJQQJG2Uwjk\n6/HIJJh/wbxsEdLNV2crYU/EiVO3A4Bq0YTHUlbhUqG3mSCr5Ec="
-    - secure: "gejXUAHYscbR6Bodw35XexpToqWkv2ifeECsbeEmjaLkYzXmUUNWJGknKSu7\nEUsSfQV8w+hxApr1Z+jNqk9aX3K1I4btL3cwk2trnNI8XRAvu1c1Iv60eerI\nkE82Rsd5lwUaMEh+/HoL8ztFCZamVndoNgX7HWp5J/NRZZMmh4g="
-
-_set_loglevel_warn: &set_loglevel_warn |
-  sed -e 's/"loglevel":[^,]*/"loglevel": "WARN"/' \
-      settings.json.template >settings.json.template.new &&
-  mv settings.json.template.new settings.json.template
-
-_enable_admin_tests: &enable_admin_tests |
-sed -e 's/"enableAdminUITests": false/"enableAdminUITests": true,\n"users":{"admin":{"password":"changeme","is_admin":true}}/' \
-      settings.json.template >settings.json.template.new &&
-  mv settings.json.template.new settings.json.template
-
-_install_libreoffice: &install_libreoffice >-
-  sudo add-apt-repository -y ppa:libreoffice/ppa &&
-  sudo apt-get update &&
-  sudo apt-get -y install libreoffice libreoffice-pdfimport
-
-# The --legacy-peer-deps flag is required to work around a bug in npm v7:
-# https://github.com/npm/cli/issues/2199
-_install_plugins: &install_plugins >-
-  npm install --no-save --legacy-peer-deps
-  ep_align
-  ep_author_hover
-  ep_cursortrace
-  ep_font_size
-  ep_hash_auth
-  ep_headings2
-  ep_markdown
-  ep_readonly_guest
-  ep_spellcheck
-  ep_subscript_and_superscript
-  ep_table_of_contents
-  ep_set_title_on_pad
-
-jobs:
-  include:
-    # we can only frontend tests from the ether/ organization and not from forks.
-    # To request tests to be run ask a maintainer to fork your repo to ether/
-    - if: fork = false
-      name: "Test the Frontend without Plugins"
-      install:
-        - *set_loglevel_warn
-        - *enable_admin_tests
-        - "src/tests/frontend/travis/sauce_tunnel.sh"
-        - "src/bin/installDeps.sh"
-        - "export GIT_HASH=$(git rev-parse --verify --short HEAD)"
-      script:
-        - "./src/tests/frontend/travis/runner.sh"
-    - name: "Run the Backend tests without Plugins"
-      install:
-        - *install_libreoffice
-        - *set_loglevel_warn
-        - "src/bin/installDeps.sh"
-        - "cd src && npm install && cd -"
-      script:
-        - "cd src && npm test"
-    - 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"
-    - name: "Load test Etherpad without Plugins"
-      install:
-        - *set_loglevel_warn
-        - "src/bin/installDeps.sh"
-        - "cd src && npm install && cd -"
-        - "npm install -g etherpad-load-test"
-      script:
-        - "src/tests/frontend/travis/runnerLoadTest.sh"
-    # we can only frontend tests from the ether/ organization and not from forks.
-    # To request tests to be run ask a maintainer to fork your repo to ether/
-    - if: fork = false
-      name: "Test the Frontend Plugins only"
-      install:
-        - *set_loglevel_warn
-        - *enable_admin_tests
-        - "src/tests/frontend/travis/sauce_tunnel.sh"
-        - "src/bin/installDeps.sh"
-        - "rm src/tests/frontend/specs/*"
-        - *install_plugins
-        - "export GIT_HASH=$(git rev-parse --verify --short HEAD)"
-      script:
-        - "./src/tests/frontend/travis/runner.sh"
-    - name: "Lint test package-lock.json"
-      install:
-        - "npm install lockfile-lint"
-      script:
-        - npx lockfile-lint --path src/package-lock.json --validate-https --allowed-hosts npm
-    - name: "Run the Backend tests with Plugins"
-      install:
-        - *install_libreoffice
-        - *set_loglevel_warn
-        - "src/bin/installDeps.sh"
-        - *install_plugins
-        - "cd src && npm install && cd -"
-      script:
-        - "cd src && npm test"
-    - 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"
-    - name: "Load test Etherpad with Plugins"
-      install:
-        - *set_loglevel_warn
-        - "src/bin/installDeps.sh"
-        - *install_plugins
-        - "cd src && npm install && cd -"
-        - "npm install -g etherpad-load-test"
-      script:
-        - "src/tests/frontend/travis/runnerLoadTest.sh"
-    - name: "Test rate limit"
-      install:
-        - "docker network create --subnet=172.23.42.0/16 ep_net"
-        - "docker build -f Dockerfile -t epl-debian-slim ."
-        - "docker build -f src/tests/ratelimit/Dockerfile.nginx -t nginx-latest ."
-        - "docker build -f src/tests/ratelimit/Dockerfile.anotherip -t anotherip ."
-        - "docker run -p 8081:80 --rm --network ep_net --ip 172.23.42.1 -d nginx-latest"
-        - "docker run --name etherpad-docker -p 9000:9001 --rm --network ep_net --ip 172.23.42.2 -e 'TRUST_PROXY=true' epl-debian-slim &"
-        - "docker run --rm --network ep_net --ip 172.23.42.3 --name anotherip -dt anotherip"
-        - "./src/bin/installDeps.sh"
-      script:
-        - "cd src/tests/ratelimit && bash testlimits.sh"
-
-notifications:
-  irc:
-    channels:
-      - "irc.freenode.org#etherpad-lite-dev"

CONTRIBUTING.md

@@ -1,115 +1,49 @@
-# Contributor Guidelines
-(Please talk to people on the mailing list before you change this page, see our section on [how to get in touch](https://github.com/ether/etherpad-lite#get-in-touch))
+# Developer Guidelines
 
-## Pull requests
+Please talk to people on the mailing list before you change this page
 
-* the commit series in the PR should be _linear_ (it **should not contain merge commits**). This is necessary because we want to be able to [bisect](https://en.wikipedia.org/wiki/Bisection_(software_engineering)) bugs easily. Rewrite history/perform a rebase if necessary
-* PRs should be issued against the **develop** branch: we never pull directly into **master**
-* PRs **should not have conflicts** with develop. If there are, please resolve them rebasing and force-pushing
-* when preparing your PR, please make sure that you have included the relevant **changes to the documentation** (preferably with usage examples)
-* contain meaningful and detailed **commit messages** in the form:
-  ```
-  submodule: description
+Mailing list: https://groups.google.com/forum/?fromgroups#!forum/etherpad-lite-dev
 
-  longer description of the change you have made, eventually mentioning the
-  number of the issue that is being fixed, in the form: Fixes #someIssueNumber
-  ```
-* if the PR is a **bug fix**:
-  * The commit that fixes the bug should **include a regression test** that
-    would fail if the bug fix was reverted. Adding the regression test in the
-    same commit as the bug fix makes it easier for a reviewer to verify that the
-    test is appropriate for the bug fix.
-  * If there is a bug report, **the pull request description should include the
-    text "`Fixes #xxx`"** so that the bug report is auto-closed when the PR is
-    merged. It is less useful to say the same thing in a commit message because
-    GitHub will spam the bug report every time the commit is rebased, and
-    because a bug number alone becomes meaningless in forks. (A full URL would
-    be better, but ideally each commit is readable on its own without the need
-    to examine an external reference to understand motivation or context.)
-* think about stability: code has to be backwards compatible as much as possible. Always **assume your code will be run with an older version of the DB/config file**
-* if you want to remove a feature, **deprecate it instead**:
-  * write an issue with your deprecation plan
-  * output a `WARN` in the log informing that the feature is going to be removed
-  * remove the feature in the next version
-* if you want to add a new feature, put it under a **feature flag**:
-  * once the new feature has reached a minimal level of stability, do a PR for it, so it can be integrated early
-  * expose a mechanism for enabling/disabling the feature
-  * the new feature should be **disabled** by default. With the feature disabled, the code path should be exactly the same as before your contribution. This is a __necessary condition__ for early integration
-* think of the PR not as something that __you wrote__, but as something that __someone else is going to read__. The commit series in the PR should tell a novice developer the story of your thoughts when developing it
+IRC channels: [#etherpad](irc://freenode/#etherpad) ([webchat](webchat.freenode.net?channels=etherpad)), [#etherpad-lite-dev](irc://freenode/#etherpad-lite-dev) ([webchat](webchat.freenode.net?channels=etherpad-lite-dev))
 
-## How to write a bug report
+**Our goal is to iterate in small steps. Release often, release early. Evolution instead of a revolution**
 
-* Please be polite, we all are humans and problems can occur.
-* Please add as much information as possible, for example
-  * client os(s) and version(s)
-    * browser(s) and version(s), is the problem reproducible on different clients
-    * special environments like firewalls or antivirus
-  * host os and version
-    * npm and nodejs version
-    * Logfiles if available
-  * steps to reproduce
-  * what you expected to happen
-  * what actually happened
-* Please format logfiles and code examples with markdown see github Markdown help below the issue textarea for more information.
+## General goals of Etherpad Lite
+* easy to install for admins
+* easy to use for people
+* using less resources on server side
+* easy to embed for admins
+* also runable as etherpad lite only 
+* keep it maintainable, we don't wanna end ob as the monster Etherpad was
+* extensible, as much functionality should be extendable with plugins so changes don't have to be done in core
 
-If you send logfiles, please set the loglevel switch DEBUG in your settings.json file:
-
-```
-/* The log level we are using, can be: DEBUG, INFO, WARN, ERROR */
-  "loglevel": "DEBUG",
-```
-
-The logfile location is defined in startup script or the log is directly shown in the commandline after you have started etherpad.
-
-## General goals of Etherpad
-To make sure everybody is going in the same direction:
-* easy to install for admins and easy to use for people
-* easy to integrate into other apps, but also usable as standalone
-* lightweight and scalable
-* extensible, as much functionality should be extendable with plugins so changes don't have to be done in core.
-Also, keep it maintainable. We don't wanna end up as the monster Etherpad was!
-
-## How to work with git?
-* Don't work in your master branch.
-* Make a new branch for every feature you're working on. (This ensures that you can work you can do lots of small, independent pull requests instead of one big one with complete different features)
-* Don't use the online edit function of github (this only creates ugly and not working commits!)
-* Try to make clean commits that are easy readable (including descriptive commit messages!)
-* Test before you push. Sounds easy, it isn't!
-* Don't check in stuff that gets generated during build or runtime
-* Make small pull requests that are easy to review but make sure they do add value by themselves / individually
-
-## Coding style
-* Do write comments. (You don't have to comment every line, but if you come up with something that's a bit complex/weird, just leave a comment. Bear in mind that you will probably leave the project at some point and that other people will read your code. Undocumented huge amounts of code are worthless!)
+## How to code:
+* **Please write comments**. I don't mean you have to comment every line and every loop. I just mean, if you do anything thats a bit complex or a bit weird, please leave a comment. It's easy to do that if you do while you're writing the code. Keep in mind that you will probably leave the project at some point and that other people will read your code. Undocumented huge amounts of code are worthless
 * Never ever use tabs
 * Indentation: JS/CSS: 2 spaces; HTML: 4 spaces
-* Don't overengineer. Don't try to solve any possible problem in one step, but try to solve problems as easy as possible and improve the solution over time!
-* Do generalize sooner or later! (if an old solution, quickly hacked together, poses more problems than it solves today, refactor it!)
-* Keep it compatible. Do not introduce changes to the public API, db schema or configurations too lightly. Don't make incompatible changes without good reasons!
-* If you do make changes, document them! (see below)
-* Use protocol independent urls "//"
+* Don't overengineer. Don't try to solve any possible problem in one step. Try to solve problems as easy as possible and improve the solution over time
+* Do generalize sooner or later - if an old solution hacked together according to the above point, poses more problems than it solves today, reengineer it, with the lessons learned taken into account.
+* Keep it compatible to API-Clients/older DBs/configurations. Don't make incompatible changes the protocol/database format without good reasons
 
-## Branching model / git workflow
+## How to work with git
+* Make a new branch for every feature you're working on. Don't work in your master branch. This ensures that you can work you can do lot of small pull requests instead of one big one with complete different features
+* Don't use the online edit function of github. This only creates ugly and not working commits
+* Test before you push. Sounds easy, it isn't
+* Try to make clean commits that are easy readable
+* Don't check in stuff that gets generated during build or runtime (like jquery, minified files, dbs etc...)
+* Make pull requests from your feature branch to our develop branch once your feature is ready
+* Make small pull requests that are easy to review but make sure they do add value by themselves / individually
+
+## Branching model in Etherpad Lite
 see git flow http://nvie.com/posts/a-successful-git-branching-model/
 
-### `master` branch
-* the stable
-* This is the branch everyone should use for production stuff
-
-### `develop`branch
-* everything that is READY to go into master at some point in time
-* This stuff is tested and ready to go out
-
-### release branches
-* stuff that should go into master very soon
-* only bugfixes go into these (see http://nvie.com/posts/a-successful-git-branching-model/ for why)
-* we should not be blocking new features to develop, just because we feel that we should be releasing it to master soon. This is the situation that release branches solve/handle.
-
-### hotfix branches
-* fixes for bugs in master
-
-### feature branches (in your own repos)
-* these are the branches where you develop your features in
-* If it's ready to go out, it will be merged into develop
+* master, the stable. This is the branch everyone should use for production stuff
+* develop, everything that is READY to go into master at some point in time. This stuff is tested and ready to go out
+* release branches, stuff that should go into master very soon, only bugfixes go into these (see http://nvie.com/posts/a-successful-git-branching-model/ for why)
+* you can set tags in the master branch, there is no real need for release branches imho
+* The latest tag is not what is shown in github by default. Doing a clone of master should give you latest stable, not what is gonna be latest stable in a week, also, we should not be blocking new features to develop, just because we feel that we should be releasing it to master soon. This is the situation that release branches solve/handle.
+* hotfix branches, fixes for bugs in master
+* feature branches (in your own repos), these are the branches where you develop your features in. If its ready to go out, it will be merged into develop
 
 Over the time we pull features from feature branches into the develop branch. Every month we pull from develop into master. Bugs in master get fixed in hotfix branches. These branches will get merged into master AND develop. There should never be commits in master that aren't in develop
 
@@ -118,25 +52,4 @@ The docs are in the `doc/` folder in the git repository, so people can easily fi
 
 Documentation should be kept up-to-date. This means, whenever you add a new API method, add a new hook or change the database model, pack the relevant changes to the docs in the same pull request.
 
-You can build the docs e.g. produce html, using `make docs`. At some point in the future we will provide an online documentation. The current documentation in the github wiki should always reflect the state of `master` (!), since there are no docs in master, yet.
-
-## Testing
-Front-end tests are found in the `tests/frontend/` folder in the repository. Run them by pointing your browser to `<yourdomainhere>/tests/frontend`.
-
-Back-end tests can be run from the `src` directory, via `npm test`.
-You can use `npm test -- --inspect-brk` and navigate to `edge://inspect` or `chrome://inspect` to debug the tests.
-
-## Things you can help with
-Etherpad is much more than software.  So if you aren't a developer then worry not, there is still a LOT you can do!  A big part of what we do is community engagement.  You can help in the following ways
- * Triage bugs (applying labels) and confirming their existence
- * Testing fixes (simply applying them and seeing if it fixes your issue or not) - Some git experience required
- * Notifying large site admins of new releases
- * Writing Changelogs for releases
- * Creating Windows packages
- * Creating releases
- * Bumping dependencies periodically and checking they don't break anything
- * Write proposals for grants
- * Co-Author and Publish CVEs
- * Work with SFC to maintain legal side of project
- * Maintain TODO page - https://github.com/ether/etherpad-lite/wiki/TODO#IMPORTANT_TODOS
-
+You can build the docs e.g. produce html, using `make docs`. At some point in the future we will provide an online documentation. The current documentation in the github wiki should always reflect the state of `master` (!), since there are no docs in master, yet.

Dockerfile

@@ -1,119 +0,0 @@
-# Etherpad Lite Dockerfile
-#
-# https://github.com/ether/etherpad-lite
-#
-# Author: muxator
-
-FROM node:lts-alpine
-LABEL maintainer="Etherpad team, https://github.com/ether/etherpad-lite"
-
-ARG TIMEZONE=
-
-RUN \
-  [ -z "${TIMEZONE}" ] || { \
-    apk add --no-cache tzdata && \
-    cp /usr/share/zoneinfo/${TIMEZONE} /etc/localtime && \
-    echo "${TIMEZONE}" > /etc/timezone; \
-  }
-ENV TIMEZONE=${TIMEZONE}
-
-# Control the configuration file to be copied into the container.
-ARG SETTINGS=./settings.json.docker
-
-# plugins to install while building the container. By default no plugins are
-# installed.
-# If given a value, it has to be a space-separated, quoted list of plugin names.
-#
-# EXAMPLE:
-#   ETHERPAD_PLUGINS="ep_codepad ep_author_neat"
-ARG ETHERPAD_PLUGINS=
-
-# Control whether abiword will be installed, enabling exports to DOC/PDF/ODT formats.
-# By default, it is not installed.
-# If given any value, abiword will be installed.
-#
-# EXAMPLE:
-#   INSTALL_ABIWORD=true
-ARG INSTALL_ABIWORD=
-
-# Control whether libreoffice will be installed, enabling exports to DOC/PDF/ODT formats.
-# By default, it is not installed.
-# If given any value, libreoffice will be installed.
-#
-# EXAMPLE:
-#   INSTALL_LIBREOFFICE=true
-ARG INSTALL_SOFFICE=
-
-# 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
-ENV ETHERPAD_PRODUCTION=true
-# Install dependencies required for modifying access.
-RUN apk add shadow bash
-# 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.
-#
-# If any of the following args are set to the empty string, default
-# values will be chosen.
-ARG EP_HOME=
-ARG EP_UID=5001
-ARG EP_GID=0
-ARG EP_SHELL=
-
-ENV NODE_ENV=production
-
-RUN groupadd --system ${EP_GID:+--gid "${EP_GID}" --non-unique} etherpad && \
-    useradd --system ${EP_UID:+--uid "${EP_UID}" --non-unique} --gid etherpad \
-        ${EP_HOME:+--home-dir "${EP_HOME}"} --create-home \
-        ${EP_SHELL:+--shell "${EP_SHELL}"} etherpad
-
-ARG EP_DIR=/opt/etherpad-lite
-RUN mkdir -p "${EP_DIR}" && chown etherpad:etherpad "${EP_DIR}"
-
-# the mkdir is needed for configuration of openjdk-11-jre-headless, see
-# https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=863199
-RUN  \
-    mkdir -p /usr/share/man/man1 && \
-    apk update && apk upgrade && \
-    apk add  \
-        ca-certificates \
-        git \
-        ${INSTALL_ABIWORD:+abiword abiword-plugin-command} \
-        ${INSTALL_SOFFICE:+libreoffice openjdk8-jre libreoffice-common}
-
-USER etherpad
-
-WORKDIR "${EP_DIR}"
-
-COPY --chown=etherpad:etherpad ./ ./
-
-# Plugins must be installed before installing Etherpad's dependencies, otherwise
-# npm will try to hoist common dependencies by removing them from
-# src/node_modules and installing them in the top-level node_modules. As of
-# v6.14.10, npm's hoist logic appears to be buggy, because it sometimes removes
-# dependencies from src/node_modules but fails to add them to the top-level
-# node_modules. Even if npm correctly hoists the dependencies, the hoisting
-# seems to confuse tools such as `npm outdated`, `npm update`, and some ESLint
-# rules.
-RUN { [ -z "${ETHERPAD_PLUGINS}" ] || \
-      npm install --no-save --legacy-peer-deps ${ETHERPAD_PLUGINS}; } && \
-    src/bin/installDeps.sh && \
-    rm -rf ~/.npm
-
-# Copy the configuration file.
-COPY --chown=etherpad:etherpad ${SETTINGS} "${EP_DIR}"/settings.json
-
-# Fix group permissions
-RUN chmod -R g=u .
-
-USER root
-RUN cd src && npm link
-USER etherpad
-
-HEALTHCHECK --interval=20s --timeout=3s CMD ["etherpad-healthcheck"]
-
-EXPOSE 9001
-CMD ["etherpad"]

LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -186,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2013 THE ETHERPAD FOUNDATION
+   Copyright 2012 THE ETHERPAD FOUNDATION
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

Makefile

@@ -0,0 +1,13 @@
+doc_dirs = doc $(wildcard doc/*/)
+outdoc_dirs = out $(addprefix out/,$(doc_dirs))
+doc_sources = $(wildcard doc/*/*.md) $(wildcard doc/*.md)
+outdoc_files = $(addprefix out/,$(doc_sources:.md=.html))
+
+docs: $(outdoc_files)
+
+out/doc/%.html: doc/%.md
+	mkdir -p $(@D)
+	node tools/doc/generate.js --format=html --template=doc/template.html $< > $@
+
+clean:
+	rm -rf out/

README.md

@@ -1,296 +1,126 @@
-# Etherpad: A real-time collaborative editor for the web
+# Making collaborative editing the standard on the web
 
-![Demo Etherpad Animated Jif](doc/images/etherpad_demo.gif "Etherpad in action")
+# About
+Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad. 
+We're reusing the well tested Etherpad easysync library to make it really realtime. Etherpad Lite 
+is based on node.js ergo is much lighter and more stable than the original Etherpad. Our hope 
+is that this will encourage more users to use and install a realtime collaborative editor. A smaller, manageable and well 
+documented codebase makes it easier for developers to improve the code and contribute towards the project.
 
-## About
+**Etherpad vs Etherpad lite**
+<table>
+  <tr>
+    <td>&nbsp;</td><td><b>Etherpad</b></td><td><b>Etherpad Lite</b></td>
+  </tr>
+  <tr>
+    <td align="right">Size of the folder (without git history)</td><td>30 MB</td><td>1.5 MB</td>
+  </tr>
+  <tr>
+    <td align="right">Languages used server side</td><td>Javascript (Rhino), Java, Scala</td><td>Javascript (node.js)</td>
+  </tr>
+  <tr>
+    <td align="right">Lines of server side Javascript code</td><td>~101k</td><td>~9k</td>
+  </tr>
+  <tr>
+    <td align="right">RAM Usage immediately after start</td><td>257 MB (grows to ~1GB)</td><td>16 MB (grows to ~30MB)</td>
+  </tr>
+</table> 
 
-Etherpad is a real-time collaborative editor [scalable to thousands of
-simultaneous real time users](http://scale.etherpad.org/). It provides [full
-data
-export](https://github.com/ether/etherpad-lite/wiki/Understanding-Etherpad's-Full-Data-Export-capabilities)
-capabilities, and runs on _your_ server, under _your_ control.
 
-## Try it out
+Etherpad Lite is designed to be easily embeddable and provides a [HTTP API](https://github.com/Pita/etherpad-lite/wiki/HTTP-API) 
+that allows your web application to manage pads, users and groups. It is recommended to use the client implementations available for this API, listed on [this wiki page](https://github.com/Pita/etherpad-lite/wiki/HTTP-API-client-libraries).
+There is also a [jQuery plugin](https://github.com/johnyma22/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website
 
-Wikimedia provide a [public Etherpad instance for you to Try Etherpad out.](https://etherpad.wikimedia.org) or [use another public Etherpad instance to see other features](https://github.com/ether/etherpad-lite/wiki/Sites-That-Run-Etherpad#sites-that-run-etherpad)
+**Visit [beta.etherpad.org](http://beta.etherpad.org) to test it live**
 
-## Project Status
+Also, check out the **[FAQ](https://github.com/Pita/etherpad-lite/wiki/FAQ)**, really!
 
-We're looking for maintainers and have some funding available.  Please contact John McLear if you can help.
+# Installation
 
-### Code Quality
+## Windows
 
-[![Code Quality](https://github.com/ether/etherpad-lite/actions/workflows/codeql-analysis.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/codeql-analysis.yml)
-[![package.lock](https://github.com/ether/etherpad-lite/actions/workflows/lint-package-lock.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/lint-package-lock.yml)
+### Prebuilt windows package
+This package works out of the box on any windows machine, but it's not very useful for developing purposes...
 
-### Testing
+1. Download the windows package <https://github.com/Pita/etherpad-lite/downloads>
+2. Extract the folder
 
-[![Backend tests](https://github.com/ether/etherpad-lite/actions/workflows/backend-tests.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/backend-tests.yml)
-[![Simulated Load](https://github.com/ether/etherpad-lite/actions/workflows/load-test.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/load-test.yml)
-[![Rate Limit](https://github.com/ether/etherpad-lite/actions/workflows/rate-limit.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/rate-limit.yml)
-[![Docker file](https://github.com/ether/etherpad-lite/actions/workflows/dockerfile.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/dockerfile.yml)
-[![Frontend admin tests powered by Sauce Labs](https://github.com/ether/etherpad-lite/actions/workflows/frontend-admin-tests.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/frontend-admin-tests.yml)
-[![Frontend tests powered by Sauce Labs](https://github.com/ether/etherpad-lite/actions/workflows/frontend-tests.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/frontend-tests.yml)
-[![Sauce Test Status](https://saucelabs.com/buildstatus/etherpad.svg)](https://saucelabs.com/u/etherpad)
-[![Windows Build](https://github.com/ether/etherpad-lite/actions/workflows/windows.yml/badge.svg?color=%2344b492)](https://github.com/ether/etherpad-lite/actions/workflows/windows.yml)
+Now, run `start.bat` and open <http://localhost:9001> in your browser. You like it? [Next steps](#next-steps).
 
-### Engagement
+### Fancy install
+You'll need [node.js](http://nodejs.org) and (optionally, though recommended) git.
 
-[![Docker Pulls](https://img.shields.io/docker/pulls/etherpad/etherpad?color=%2344b492)](https://hub.docker.com/r/etherpad/etherpad)
-[![Discord](https://img.shields.io/discord/741309013593030667?color=%2344b492)](https://discord.com/invite/daEjfhw)
-[![Etherpad plugins](https://img.shields.io/endpoint?url=https%3A%2F%2Fstatic.etherpad.org%2Fshields.json&color=%2344b492 "Etherpad plugins")](https://static.etherpad.org/index.html)
-![Languages](https://img.shields.io/static/v1?label=Languages&message=105&color=%2344b492)
-![Translation Coverage](https://img.shields.io/static/v1?label=Languages&message=98%&color=%2344b492)
+1. Grab the source, either
+  - download <https://github.com/Pita/etherpad-lite/zipball/master>
+  - or `git clone https://github.com/Pita/etherpad-lite.git` (for this you need git, obviously)
+2. start `bin\installOnWindows.bat`
 
-## Installation
+Now, run `start.bat` and open <http://localhost:9001> in your browser.
 
-### Requirements
+Update to the latest version with `git pull origin`, then run `bin\installOnWindows.bat`, again.
 
-[Node.js](https://nodejs.org/) >= **16.20.1**.
+[Next steps](#next-steps).
 
-### GNU/Linux and other UNIX-like systems
+## Linux
+You'll need gzip, git, curl, libssl develop libraries, python and gcc.  
+*For Debian/Ubuntu*: `apt-get install gzip git-core curl python libssl-dev pkg-config build-essential`  
+*For Fedora/CentOS*: `yum install gzip git-core curl python openssl-devel && yum groupinstall "Development Tools"`
 
-#### Quick install on Debian/Ubuntu
+Additionally, you'll need [node.js](http://nodejs.org).
 
-```sh
-curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
-sudo apt install -y nodejs
-git clone --branch master https://github.com/ether/etherpad-lite.git &&
-cd etherpad-lite &&
-src/bin/run.sh
-```
+**As any user (we recommend creating a separate user called etherpad-lite):**
 
-#### Manual install
+1. Move to a folder where you want to install Etherpad Lite. Clone the git repository `git clone git://github.com/Pita/etherpad-lite.git`
+2. Change into the new directory containing the cloned source code `cd etherpad-lite`
 
-You'll need Git and [Node.js](https://nodejs.org/) installed.
+Now, run `bin\run.sh` and open <http://127.0.0.1:9001> in your browser. 
 
-**As any user (we recommend creating a separate user called etherpad):**
+Update to the latest version with `git pull origin`. The next start with bin/run.sh will update the dependencies.
 
-  1. Move to a folder where you want to install Etherpad.
-  2. Clone the Git repository: `git clone --branch master
-     https://github.com/ether/etherpad-lite.git`
-  3. Change into the new directory containing the cloned source code: `cd
-     etherpad-lite`
-  4. Run `src/bin/run.sh` and open http://127.0.0.1:9001 in your browser.
+You like it? [Next steps](#next-steps).
 
-To update to the latest released version, execute `git pull origin`. The next
-start with `src/bin/run.sh` will update the dependencies.
+# Next Steps
 
-### Windows
+## Tweak the settings
+You can modify the settings in `settings.json`. (If you need to handle multiple settings files, you can pass the path to a settings file to `bin/run.sh` using the `-s|--settings` option. This allows you to run multiple Etherpad Lite instances from the same installation.)
 
-#### Prebuilt Windows package
-
-This package runs on any Windows machine. You can perform a manual installation
-via git for development purposes, but as this uses symlinks which performs
-unreliably on Windows, please stick to the prebuilt package if possible.
-
-  1. [Download the latest Windows package](https://etherpad.org/#download)
-  2. Extract the folder
-
-Run `start.bat` and open <http://localhost:9001> in your browser.
-
-#### Manually install on Windows
-
-You'll need [Node.js](https://nodejs.org) and (optionally, though recommended)
-git.
-
-  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. With a "Run as administrator" command prompt execute
-     `src\bin\installOnWindows.bat`
-
-Now, run `start.bat` and open http://localhost:9001 in your browser.
-
-Update to the latest version with `git pull origin`, then run
-`src\bin\installOnWindows.bat`, again.
-
-If cloning to a subdirectory within another project, you may need to do the
-following:
-
-  1. Start the server manually (e.g. `node src/node/server.js`)
-  2. Edit the db `filename` in `settings.json` to the relative directory with
-     the file (e.g. `application/lib/etherpad-lite/var/dirty.db`)
-  3. Add auto-generated files to the main project `.gitignore`
-
-### Docker container
-
-Find [here](doc/docker.adoc) information on running Etherpad in a container.
-
-## Plugins
-
-Etherpad is very customizable through 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 !")
-
-### Available Plugins
-
-For a list of available plugins, see the [plugins
-site](https://static.etherpad.org).
-
-### Plugin Installation
-
-You can install plugins from the admin web interface (e.g.,
-http://127.0.0.1:9001/admin/plugins).
-
-Alternatively, you can install plugins from the command line:
-
-```sh
-cd /path/to/etherpad-lite
-# The `--no-save` and `--legacy-peer-deps` arguments are necessary to work
-# around npm quirks.
-npm install --no-save --legacy-peer-deps ep_${plugin_name}
-```
-
-Also see [the plugin wiki
-article](https://github.com/ether/etherpad-lite/wiki/Available-Plugins).
-
-### Suggested Plugins
-
-Run the following command in your Etherpad folder to get all of the features
-visible in the above demo gif:
-
-```sh
-npm install --no-save --legacy-peer-deps \
-  ep_align \
-  ep_comments_page \
-  ep_embedded_hyperlinks2 \
-  ep_font_color \
-  ep_headings2 \
-  ep_markdown \
-  ep_webrtc
-```
-
-For user authentication, you are encouraged to run an [OpenID
-Connect](https://openid.net/connect/) identity provider (OP) and install the
-following plugins:
-
-  * [ep_openid_connect](https://github.com/ether/ep_openid_connect#readme) to
-    authenticate against your OP.
-  * [ep_guest](https://github.com/ether/ep_guest#readme) to create a
-    "guest" account that has limited access (e.g., read-only access).
-  * [ep_user_displayname](https://github.com/ether/ep_user_displayname#readme)
-    to automatically populate each user's displayed name from your OP.
-  * [ep_stable_authorid](https://github.com/ether/ep_stable_authorid#readme) so
-    that each user's chosen color, display name, comment ownership, etc. is
-    strongly linked to their account.
-
-## Next Steps
-
-### Tweak the settings
-
-You can modify the settings in `settings.json`. If you need to handle multiple
-settings files, you can pass the path to a settings file to `src/bin/run.sh`
-using the `-s|--settings` option: this allows you to run multiple Etherpad
-instances from the same installation. Similarly, `--credentials` can be used to
-give a settings override file, `--apikey` to give a different APIKEY.txt file
-and `--sessionkey` to give a non-default `SESSIONKEY.txt`. **Each configuration
-parameter can also be set via an environment variable**, using the syntax
-`"${ENV_VAR}"` or `"${ENV_VAR:default_value}"`. For details, refer to
-`settings.json.template`. Once you have access to your `/admin` section,
-settings can be modified through the web browser.
-
-If you are planning to use Etherpad in a production environment, you should use
-a dedicated database such as `mysql`, since the `dirtyDB` database driver is
-only for testing and/or development purposes.
-
-### Secure your installation
-
-If you have enabled authentication in `users` section in `settings.json`, it is
-a good security practice to **store hashes instead of plain text passwords** in
-that file. This is _especially_ advised if you are running a production
-installation.
-
-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.
-
-### 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")
+You should use a dedicated database such as "mysql", if you are planning on using etherpad-lite in a production environment, since the "dirtyDB" database driver is only for testing and/or development purposes.
 
 ## Helpful resources
+The [wiki](https://github.com/Pita/etherpad-lite/wiki) is your one-stop resource for Tutorials and How-to's, really check it out! Also, feel free to improve these wiki pages.
 
-The [wiki](https://github.com/ether/etherpad-lite/wiki) is your one-stop
-resource for Tutorials and How-to's.
+Documentation can be found in `docs/`.
 
-Documentation can be found in `doc/`.
+# Development
 
-## Development
+## Things you should know
+Read this [git guide](http://learn.github.com/p/intro.html) and watch this [video on getting started with Etherpad Lite Development](http://youtu.be/67-Q26YH97E).
 
-### Things you should know
+If you're new to node.js, start with Ryan Dahl's [Introduction to Node.js](http://youtu.be/jo_B4LTHi3I).
 
-You can debug Etherpad using `src/bin/debugRun.sh`.
+You can debug Etherpad lite using `bin/debugRun.sh`.
 
-You can run Etherpad quickly launching `src/bin/fastRun.sh`. It's convenient for
-developers and advanced users. Be aware that it will skip the dependencies
-update, so remember to run `src/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/Pita/etherpad-lite/raw/master/doc/easysync/easysync-full-description.pdf) (complex, but worth reading).
 
-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).
+## Getting started
+You know all this and just want to know how you can help?
 
-### Contributing
+Look at the [TODO list](https://github.com/Pita/etherpad-lite/wiki/TODO) and our [Issue tracker](https://github.com/Pita/etherpad-lite/issues). (Please consider using [jshint](http://www.jshint.com/about/), if you plan to contribute code.)
 
-Read our [**Developer
-Guidelines**](https://github.com/ether/etherpad-lite/blob/master/CONTRIBUTING.md)
+Also, and most importantly, read our [**Developer Guidelines**](https://github.com/Pita/etherpad-lite/wiki/Developer-Guidelines), really!
 
-### HTTP API
+# Get in touch
+Join the [mailinglist](http://groups.google.com/group/etherpad-lite-dev) and make some noise on our freenode irc channel [#etherpad-lite-dev](http://webchat.freenode.net?channels=#etherpad-lite-dev)!
 
-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.
+# Modules created for this project
 
-OpenAPI (previously swagger) definitions for the API are exposed under
-`/api/openapi.json`.
+* [ueberDB](https://github.com/Pita/ueberDB) "transforms every database into a object key value store" - manages all database access
+* [channels](https://github.com/Pita/channels) "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key
+* [async-stacktrace](https://github.com/Pita/async-stacktrace) "Improves node.js stacktraces and makes it easier to handle errors"
 
-### jQuery plugin
+# Donate!
+* [Flattr] (http://flattr.com/thing/71378/Etherpad-Foundation)
+* Paypal - Press the donate button on [etherpad.org](http://etherpad.org)
 
-There is a [jQuery plugin](https://github.com/ether/etherpad-lite-jquery-plugin)
-that helps you to embed Pads into your website.
-
-### Plugin Framework
-
-Etherpad offers a plugin framework, allowing you to easily add your own
-features. By default your Etherpad is extremely light-weight and it's up to you
-to customize your experience. Once you have Etherpad installed you should [visit
-the plugin page](https://static.etherpad.org/) and take control.
-
-### Translations / Localizations  (i18n / l10n)
-
-Etherpad comes with translations into all languages thanks to the team at
-[TranslateWiki](https://translatewiki.net/).
-
-If you require translations in [plugins](https://static.etherpad.org/) please
-send pull request to each plugin individually.
-
-## FAQ
-
-Visit the **[FAQ](https://github.com/ether/etherpad-lite/wiki/FAQ)**.
-
-## Get in touch
-
-The official channel for contacting the development team is via the [GitHub
-issues](https://github.com/ether/etherpad-lite/issues).
-
-For **responsible disclosure of vulnerabilities**, please write a mail to the
-maintainers (a.mux@inwind.it and contact@etherpad.org).
-
-Join the official [Etherpad Discord
-Channel](https://discord.com/invite/daEjfhw).
-
-## License
-
-[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)
+# License
+[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)

README.plugins

@@ -0,0 +1,16 @@
+So, a plugin is an npm package whose name starts with ep_ and that contains a file ep.json
+require("ep_etherpad-lite/static/js/plugingfw/plugins").update() will use npm to list all installed modules and read their ep.json files. These will contain registrations for hooks which are loaded
+A hook registration is a pairs of a hook name and a function reference (filename for require() plus function name)
+require("ep_etherpad-lite/static/js/plugingfw/hooks").callAll("hook_name", {argname:value}) will call all hook functions registered for hook_name
+That is the basis.
+Ok, so that was a slight simplification: inside ep.json, hook registrations are grouped into groups called "parts". Parts from all plugins are ordered using a topological sort according to "pre" and "post" pointers to other plugins/parts (just like dependencies, but non-installed plugins are silently ignored).
+This ordering is honored when you do callAll(hook_name) - hook functions for that hook_name are called in that order
+Ordering between plugins is undefined, only parts are ordered.
+
+A plugin usually has one part, but it van have multiple.
+This is so that it can insert some hook registration before that of another plugin, and another one after.
+This is important for e.g. registering URL-handlers for the express webserver, if you have some very generic and some very specific url-regexps
+So, that's basically it... apart from client-side hooks
+which works the same way, but uses a separate member of the part (part.client_hooks vs part.hooks), and where the hook function must obviously reside in a file require():able from the client...
+One thing more: The main etherpad tree is actually a plugin itself, called ep_etherpad-lite, and it has it's own ep.json...
+was that clear?

SECURITY.md

@@ -1,5 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-Please email contact@etherpad.org to report security related issues.

available_plugins/ep_fintest/.npmignore

@@ -0,0 +1,7 @@
+.git*
+docs/
+examples/
+support/
+test/
+testing.js
+.DS_Store

available_plugins/ep_fintest/ep.json

@@ -0,0 +1,36 @@
+{
+  "parts": [
+    {
+      "name": "somepart",
+      "pre": [],
+      "post": ["ep_onemoreplugin/partone"]
+    },
+    {
+      "name": "partlast",
+      "pre": ["ep_fintest/otherpart"],
+      "post": [],
+      "hooks": {
+	"somehookname": "ep_fintest/partlast:somehook"
+      }
+    },
+    {
+      "name": "partfirst",
+      "pre": [],
+      "post": ["ep_onemoreplugin/somepart"]
+    },
+    {
+      "name": "otherpart",
+      "pre": ["ep_fintest/somepart", "ep_otherplugin/main"],
+      "post": [],
+      "hooks": {
+	"somehookname": "ep_fintest/otherpart:somehook",
+	"morehook": "ep_fintest/otherpart:morehook",
+	"expressCreateServer": "ep_fintest/otherpart:expressServer",
+	"eejsBlock_editbarMenuLeft": "ep_fintest/otherpart:eejsBlock_editbarMenuLeft"
+      },
+      "client_hooks": {
+        "somehookname": "ep_fintest/static/js/test:bar"
+      }
+    }
+  ]
+}

available_plugins/ep_fintest/otherpart.js

@@ -0,0 +1,25 @@
+test = require("ep_fintest/static/js/test.js");
+console.log("FOOO:", test.foo);
+
+exports.somehook = function (hook_name, args, cb) {
+  return cb(["otherpart:somehook was here"]);
+}
+
+exports.morehook = function (hook_name, args, cb) {
+  return cb(["otherpart:morehook was here"]);
+}
+
+exports.expressServer = function (hook_name, args, cb) {
+  args.app.get('/otherpart', function(req, res) { 
+      res.send("<em>Abra cadabra</em>");
+  });
+}
+
+exports.eejsBlock_editbarMenuLeft = function (hook_name, args, cb) {
+  args.content = args.content + '\
+		    <li id="testButton" onClick="window.pad&amp;&amp;pad.editbarClick(\'clearauthorship\');return false;">\
+			<a class="buttonicon buttonicon-test" title="Test test test"></a>\
+		    </li>\
+  ';
+  return cb();
+}

available_plugins/ep_fintest/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "ep_fintest",
+  "description": "A test plugin",
+  "version": "0.0.1",
+  "author": "RedHog (Egil Moeller) <egil.moller@freecode.no>",
+  "contributors": [],
+  "dependencies": {},
+  "engines": { "node": ">= 0.4.1 < 0.7.0" }
+}

available_plugins/ep_fintest/partlast.js

@@ -0,0 +1,3 @@
+exports.somehook = function (hook_name, args, cb) {
+  return cb(["partlast:somehook was here"]);
+}

available_plugins/ep_fintest/static/js/test.js

@@ -0,0 +1,5 @@
+exports.foo = 42;
+
+exports.bar = function (hook_name, args, cb) {
+ return cb(["FOOOO"]);
+}

available_plugins/ep_fintest/static/test.html

@@ -0,0 +1 @@
+<em>Test bla bla</em>

bin

@@ -1 +0,0 @@
-src/bin

bin/buildForWindows.sh

@@ -0,0 +1,63 @@
+#!/bin/sh
+
+NODE_VERSION="0.8.4"
+
+#Move to the folder where ep-lite is installed
+cd `dirname $0`
+
+#Was this script started in the bin folder? if yes move out
+if [ -d "../bin" ]; then
+  cd "../"
+fi
+
+#Is wget installed?
+hash wget > /dev/null 2>&1 || { 
+  echo "Please install wget" >&2
+  exit 1 
+}
+
+#Is zip installed?
+hash zip > /dev/null 2>&1 || { 
+  echo "Please install zip" >&2
+  exit 1 
+}
+
+#Is zip installed?
+hash unzip > /dev/null 2>&1 || { 
+  echo "Please install unzip" >&2
+  exit 1 
+}
+
+START_FOLDER=$(pwd);
+
+echo "create a clean environment in /tmp/etherpad-lite-win..." 
+rm -rf /tmp/etherpad-lite-win
+cp -ar . /tmp/etherpad-lite-win
+cd /tmp/etherpad-lite-win
+rm -rf node_modules
+rm -f etherpad-lite-win.zip
+
+echo "do a normal unix install first..."
+bin/installDeps.sh || exit 1
+
+echo "copy the windows settings template..."
+cp settings.json.template settings.json
+
+echo "resolve symbolic links..."
+cp -rL node_modules node_modules_resolved
+rm -rf node_modules
+mv node_modules_resolved node_modules
+
+echo "download windows node..."
+cd bin
+wget "http://nodejs.org/dist/v$NODE_VERSION/node.exe" -O ../node.exe
+
+echo "create the zip..."
+cd /tmp
+zip -9 -r etherpad-lite-win.zip etherpad-lite-win
+mv etherpad-lite-win.zip $START_FOLDER
+
+echo "clean up..."
+rm -rf /tmp/etherpad-lite-win
+
+echo "Finished. You can find the zip in the Etherpad Lite root folder, it's called etherpad-lite-win.zip"

bin/checkPad.js

@@ -0,0 +1,134 @@
+/*
+  This is a debug tool. It checks all revisions for data corruption
+*/
+
+if(process.argv.length != 3)
+{
+  console.error("Use: node bin/checkPad.js $PADID");
+  process.exit(1);
+}
+//get the padID
+var padId = process.argv[2];
+
+//initalize the database
+var log4js = require("../src/node_modules/log4js");
+log4js.setGlobalLogLevel("INFO");
+var async = require("../src/node_modules/async");
+var db = require('../src/node/db/DB');
+
+var Changeset = require("ep_etherpad-lite/static/js/Changeset");
+var padManager;
+
+async.series([
+  //intallize the database
+  function (callback)
+  {
+    db.init(callback);
+  },
+  //get the pad 
+  function (callback)
+  {
+    padManager = require('../src/node/db/PadManager');
+    
+    padManager.doesPadExists(padId, function(err, exists)
+    {
+      if(!exists)
+      {
+        console.error("Pad does not exist");
+        process.exit(1);
+      }
+      
+      padManager.getPad(padId, function(err, _pad)  
+      {
+        pad = _pad;
+        callback(err);
+      });
+    });
+  },
+  function (callback)
+  {    
+    //create an array with key kevisions
+    //key revisions always save the full pad atext
+    var head = pad.getHeadRevisionNumber();
+    var keyRevisions = [];
+    for(var i=0;i<head;i+=100)
+    {
+      keyRevisions.push(i);
+    }
+    
+    //run trough all key revisions
+    async.forEachSeries(keyRevisions, function(keyRev, callback)
+    {
+      //create an array of revisions we need till the next keyRevision or the End
+      var revisionsNeeded = [];
+      for(var i=keyRev;i<=keyRev+100 && i<=head; i++)
+      {
+        revisionsNeeded.push(i);
+      }
+      
+      //this array will hold all revision changesets
+      var revisions = [];
+      
+      //run trough all needed revisions and get them from the database
+      async.forEach(revisionsNeeded, function(revNum, callback)
+      {
+        db.db.get("pad:"+padId+":revs:" + revNum, function(err, revision)
+        {
+          revisions[revNum] = revision;
+          callback(err);
+        });
+      }, function(err)
+      {
+        if(err)
+        {
+          callback(err);
+          return;
+        }
+        
+        //check if the pad has a pool
+        if(pad.pool === undefined )
+        {
+          console.error("Attribute pool is missing");
+          process.exit(1);
+        }
+        
+        //check if there is a atext in the keyRevisions
+        if(revisions[keyRev] === undefined || revisions[keyRev].meta === undefined || revisions[keyRev].meta.atext === undefined)
+        {
+          console.error("No atext in key revision " + keyRev);
+          callback();
+          return;
+        }
+        
+        var apool = pad.pool;
+        var atext = revisions[keyRev].meta.atext;
+        
+        for(var i=keyRev+1;i<=keyRev+100 && i<=head; i++)
+        {
+          try
+          {
+            //console.log("check revision " + i);
+            var cs = revisions[i].changeset;
+            atext = Changeset.applyToAText(cs, atext, apool);
+          }
+          catch(e)
+          {
+            console.error("Bad changeset at revision " + i + " - " + e.message);
+            callback();
+            return;
+          }
+        }
+        
+        callback();
+      });
+    }, callback);
+  }
+], function (err)
+{
+  if(err) throw err;
+  else 
+  { 
+    console.log("finished");
+    process.exit(0);
+  }
+});

bin/convert.js

@@ -0,0 +1,454 @@
+
+var startTime = new Date().getTime();
+var fs = require("fs");
+var ueberDB = require("ueberDB");
+var mysql = require("mysql");
+var async = require("async");
+var Changeset = require("ep_etherpad-lite/static/js/Changeset");
+var randomString = require('ep_etherpad-lite/static/js/pad_utils').randomString;
+var AttributePool = require("ep_etherpad-lite/static/js/AttributePool");
+
+var settingsFile = process.argv[2];
+var sqlOutputFile = process.argv[3];
+
+//stop if the settings file is not set
+if(!settingsFile || !sqlOutputFile)
+{
+  console.error("Use: node convert.js $SETTINGSFILE $SQLOUTPUT");
+  process.exit(1);
+}
+
+log("read settings file...");
+//read the settings file and parse the json
+var settings = JSON.parse(fs.readFileSync(settingsFile, "utf8"));
+log("done");
+
+log("open output file...");
+var sqlOutput = fs.openSync(sqlOutputFile, "w");
+var sql = "SET CHARACTER SET UTF8;\n" +
+          "CREATE TABLE IF NOT EXISTS `store` ( \n" +
+          "`key` VARCHAR( 100 ) NOT NULL , \n" + 
+          "`value` LONGTEXT NOT NULL , \n" + 
+          "PRIMARY KEY (  `key` ) \n" +
+          ") ENGINE = INNODB;\n" + 
+          "START TRANSACTION;\n\n";
+fs.writeSync(sqlOutput, sql);
+log("done");
+
+//set setings for ep db
+var etherpadDB= new mysql.Client();
+etherpadDB.host = settings.etherpadDB.host; 
+etherpadDB.port = settings.etherpadDB.port;
+etherpadDB.database = settings.etherpadDB.database; 
+etherpadDB.user = settings.etherpadDB.user; 
+etherpadDB.password = settings.etherpadDB.password; 
+
+//get the timestamp once
+var timestamp = new Date().getTime();
+
+var padIDs;
+
+async.series([
+  //get all padids out of the database...
+  function(callback)
+  {
+    log("get all padIds out of the database...");
+    
+    etherpadDB.query("SELECT ID FROM PAD_META", [], function(err, _padIDs)
+    {
+      padIDs = _padIDs;
+      callback(err);
+    });
+  },
+  function(callback)
+  {
+    log("done");
+    
+    //create a queue with a concurrency 100
+    var queue = async.queue(function (padId, callback) 
+    {
+      convertPad(padId, function(err)
+      {
+        incrementPadStats();
+        callback(err);
+      });
+    }, 100);
+    
+    //set the step callback as the queue callback
+    queue.drain = callback;
+    
+    //add the padids to the worker queue
+    for(var i=0,length=padIDs.length;i<length;i++)
+    {
+      queue.push(padIDs[i].ID);
+    }
+  }
+], function(err)
+{
+  if(err) throw err;
+  
+  //write the groups
+  var sql = "";
+  for(var proID in proID2groupID)
+  {
+    var groupID = proID2groupID[proID];
+    var subdomain = proID2subdomain[proID];
+    
+    sql+="REPLACE INTO store VALUES (" + etherpadDB.escape("group:" + groupID) + ", " + etherpadDB.escape(JSON.stringify(groups[groupID]))+ ");\n";
+    sql+="REPLACE INTO store VALUES (" + etherpadDB.escape("mapper2group:subdomain:" + subdomain) + ", " + etherpadDB.escape(groupID)+ ");\n";
+  }
+  
+  //close transaction
+  sql+="COMMIT;";
+  
+  //end the sql file
+  fs.writeSync(sqlOutput, sql, undefined, "utf-8");
+  fs.closeSync(sqlOutput);
+  
+  log("finished.");
+  process.exit(0);
+});
+
+function log(str)
+{
+  console.log((new Date().getTime() - startTime)/1000 + "\t" + str);
+}
+
+var padsDone = 0;
+
+function incrementPadStats()
+{
+  padsDone++;
+  
+  if(padsDone%100 == 0)
+  {
+    var averageTime = Math.round(padsDone/((new Date().getTime() - startTime)/1000));
+    log(padsDone + "/" + padIDs.length + "\t" + averageTime + " pad/s")
+  }
+}
+
+var proID2groupID = {};
+var proID2subdomain = {};
+var groups = {};
+
+function convertPad(padId, callback)
+{
+  var changesets = [];
+  var changesetsMeta = [];
+  var chatMessages = [];
+  var authors = [];
+  var apool;
+  var subdomain;
+  var padmeta;
+
+  async.series([
+    //get all needed db values
+    function(callback)
+    {
+      async.parallel([
+        //get the pad revisions
+        function(callback)
+        {
+          var sql = "SELECT * FROM `PAD_CHAT_TEXT` WHERE NUMID = (SELECT `NUMID` FROM `PAD_CHAT_META` WHERE ID=?)";
+          
+          etherpadDB.query(sql, [padId], function(err, results)
+          {
+            if(!err) 
+            {
+              try
+              {
+                //parse the pages
+                for(var i=0,length=results.length;i<length;i++)
+                {
+                  parsePage(chatMessages, results[i].PAGESTART, results[i].OFFSETS, results[i].DATA, true);
+                }
+              }catch(e) {err = e}
+            }
+            
+            callback(err);
+          });
+        },
+        //get the chat entries
+        function(callback)
+        {
+          var sql = "SELECT * FROM `PAD_REVS_TEXT` WHERE NUMID = (SELECT `NUMID` FROM `PAD_REVS_META` WHERE ID=?)";
+          
+          etherpadDB.query(sql, [padId], function(err, results)
+          {
+            if(!err) 
+            {
+              try
+              {
+                //parse the pages
+                for(var i=0,length=results.length;i<length;i++)
+                {
+                  parsePage(changesets, results[i].PAGESTART, results[i].OFFSETS, results[i].DATA, false);
+                }
+              }catch(e) {err = e}
+            }
+            
+            callback(err);
+          });
+        },
+        //get the pad revisions meta data
+        function(callback)
+        {
+          var sql = "SELECT * FROM `PAD_REVMETA_TEXT` WHERE NUMID = (SELECT `NUMID` FROM `PAD_REVMETA_META` WHERE ID=?)";
+          
+          etherpadDB.query(sql, [padId], function(err, results)
+          {
+            if(!err) 
+            {
+              try
+              {
+                //parse the pages
+                for(var i=0,length=results.length;i<length;i++)
+                {
+                  parsePage(changesetsMeta, results[i].PAGESTART, results[i].OFFSETS, results[i].DATA, true);
+                }
+              }catch(e) {err = e}
+            }
+            
+            callback(err);
+          });
+        },
+        //get the attribute pool of this pad
+        function(callback)
+        {
+          var sql = "SELECT `JSON` FROM `PAD_APOOL` WHERE `ID` = ?";
+          
+          etherpadDB.query(sql, [padId], function(err, results)
+          {
+            if(!err)
+            {
+              try
+              {
+                apool=JSON.parse(results[0].JSON).x;
+              }catch(e) {err = e}
+            }
+            
+            callback(err);
+          });
+        },
+        //get the authors informations
+        function(callback)
+        {
+          var sql = "SELECT * FROM `PAD_AUTHORS_TEXT` WHERE NUMID = (SELECT `NUMID` FROM `PAD_AUTHORS_META` WHERE ID=?)";
+          
+          etherpadDB.query(sql, [padId], function(err, results)
+          {
+            if(!err) 
+            {
+              try
+              {
+                //parse the pages
+                for(var i=0, length=results.length;i<length;i++)
+                {
+                  parsePage(authors, results[i].PAGESTART, results[i].OFFSETS, results[i].DATA, true);
+                }
+              }catch(e) {err = e}
+            }
+            
+            callback(err);
+          });
+        },
+        //get the pad information
+        function(callback)
+        {
+          var sql = "SELECT JSON FROM `PAD_META` WHERE ID=?";
+          
+          etherpadDB.query(sql, [padId], function(err, results)
+          {
+            if(!err) 
+            {
+              try
+              {
+                padmeta = JSON.parse(results[0].JSON).x;
+              }catch(e) {err = e}
+            }
+            
+            callback(err);
+          });
+        },
+        //get the subdomain
+        function(callback)
+        {
+          //skip if this is no proPad
+          if(padId.indexOf("$") == -1)
+          {
+            callback();
+            return;
+          }
+          
+          //get the proID out of this padID
+          var proID = padId.split("$")[0];
+        
+          var sql = "SELECT subDomain FROM pro_domains WHERE ID = ?";
+          
+          etherpadDB.query(sql, [proID], function(err, results)
+          {
+            if(!err)
+            {
+              subdomain = results[0].subDomain;
+            }
+            
+            callback(err);
+          });
+        }
+      ], callback);
+    },
+    function(callback)
+    {
+      //saves all values that should be written to the database
+      var values = {};
+      
+      //this is a pro pad, let's convert it to a group pad
+      if(padId.indexOf("$") != -1)
+      {
+        var padIdParts = padId.split("$");
+        var proID = padIdParts[0];
+        var padName = padIdParts[1];
+        
+        var groupID
+        
+        //this proID is not converted so far, do it
+        if(proID2groupID[proID] == null)
+        {
+          groupID = "g." + randomString(16);
+          
+          //create the mappers for this new group
+          proID2groupID[proID] = groupID;
+          proID2subdomain[proID] = subdomain;
+          groups[groupID] = {pads: {}};
+        }
+        
+        //use the generated groupID;
+        groupID = proID2groupID[proID];
+        
+        //rename the pad
+        padId = groupID + "$" + padName;
+        
+        //set the value for this pad in the group
+        groups[groupID].pads[padId] = 1;
+      }
+      
+      try
+      {
+        var newAuthorIDs = {};
+        var oldName2newName = {};
+        
+        //replace the authors with generated authors
+        // we need to do that cause etherpad saves pad local authors, etherpad lite uses them global
+        for(var i in apool.numToAttrib)
+        {
+          var key = apool.numToAttrib[i][0];
+          var value = apool.numToAttrib[i][1];
+          
+          //skip non authors and anonymous authors
+          if(key != "author" || value == "")
+            continue;
+            
+          //generate new author values
+          var authorID = "a." + randomString(16);
+          var authorColorID = authors[i].colorId || Math.floor(Math.random()*32);
+          var authorName = authors[i].name || null;
+          
+          //overwrite the authorID of the attribute pool
+          apool.numToAttrib[i][1] = authorID;
+          
+          //write the author to the database
+          values["globalAuthor:" + authorID] = {"colorId" : authorColorID, "name": authorName, "timestamp": timestamp};
+          
+          //save in mappers
+          newAuthorIDs[i] = authorID;
+          oldName2newName[value] = authorID;
+        }
+        
+        //save all revisions
+        for(var i=0;i<changesets.length;i++)
+        {
+          values["pad:" + padId + ":revs:" + i] = {changeset: changesets[i], 
+                                                   meta : {
+                                                     author: newAuthorIDs[changesetsMeta[i].a],
+                                                     timestamp: changesetsMeta[i].t,
+                                                     atext: changesetsMeta[i].atext || undefined
+                                                   }};
+        }
+        
+        //save all chat messages
+        for(var i=0;i<chatMessages.length;i++)
+        {
+          values["pad:" + padId + ":chat:" + i] = {"text": chatMessages[i].lineText, 
+                                                   "userId": oldName2newName[chatMessages[i].userId], 
+                                                   "time": chatMessages[i].time}
+        }
+        
+        //generate the latest atext
+        var fullAPool = (new AttributePool()).fromJsonable(apool);
+        var keyRev = Math.floor(padmeta.head / padmeta.keyRevInterval) * padmeta.keyRevInterval;
+        var atext = changesetsMeta[keyRev].atext;
+        var curRev = keyRev;
+        while (curRev < padmeta.head) 
+        {
+          curRev++;
+          var changeset = changesets[curRev];
+          atext = Changeset.applyToAText(changeset, atext, fullAPool);
+        }
+        
+        values["pad:" + padId] = {atext: atext, 
+                                  pool: apool, 
+                                  head: padmeta.head, 
+                                  chatHead: padmeta.numChatMessages }
+      
+      }
+      catch(e)
+      {
+        console.error("Error while converting pad " + padId + ", pad skiped");
+        console.error(e.stack ? e.stack : JSON.stringify(e));
+        callback();
+        return;
+      }
+      
+      var sql = "";
+      for(var key in values)
+      {
+        sql+="REPLACE INTO store VALUES (" + etherpadDB.escape(key) + ", " + etherpadDB.escape(JSON.stringify(values[key]))+ ");\n";
+      }
+      
+      fs.writeSync(sqlOutput, sql, undefined, "utf-8");
+      callback();
+    }
+  ], callback);
+}
+
+/**
+ * This parses a Page like Etherpad uses them in the databases
+ * The offsets descripes the length of a unit in the page, the data are
+ * all values behind each other
+ */
+function parsePage(array, pageStart, offsets, data, json)
+{
+  var start = 0;
+  var lengths = offsets.split(",");
+  
+  for(var i=0;i<lengths.length;i++)
+  {
+    var unitLength = lengths[i];
+    
+    //skip empty units
+    if(unitLength == "")
+      continue;
+    
+    //parse the number
+    unitLength = Number(unitLength);
+      
+    //cut the unit out of data
+    var unit = data.substr(start, unitLength);
+    
+    //put it into the array
+    array[pageStart + i] = json ? JSON.parse(unit) : unit;
+    
+    //update start
+    start+=unitLength;
+  }
+}

bin/convertSettings.json.template

@@ -1,5 +1,5 @@
 {
-  "etherpadDB":
+  "etherpadDB": 
   {
     "host": "localhost",
     "port": 3306,

bin/debugRun.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+#Move to the folder where ep-lite is installed
+cd `dirname $0`
+
+#Was this script started in the bin folder? if yes move out
+if [ -d "../bin" ]; then
+  cd "../"
+fi
+
+#prepare the enviroment
+bin/installDeps.sh || exit 1
+
+hash node-inspector > /dev/null 2>&1 || { 
+  echo "You need to install node-inspector to run the tests!" >&2
+  echo "You can install it with npm" >&2
+  echo "Run: npm install -g node-inspector" >&2
+  exit 1 
+}
+
+node-inspector &
+
+echo "If you are new to node-inspector, take a look at this video: http://youtu.be/AOnK3NVnxL8"
+
+node --debug node_modules/ep_etherpad-lite/node/server.js $*
+
+#kill node-inspector before ending 
+kill $!

bin/extractPadData.js

@@ -0,0 +1,89 @@
+/*
+  This is a debug tool. It helps to extract all datas of a pad and move it from an productive enviroment and to a develop enviroment to reproduce bugs there. It outputs a dirtydb file
+*/
+
+if(process.argv.length != 3)
+{
+  console.error("Use: node extractPadData.js $PADID");
+  process.exit(1);
+}
+//get the padID
+var padId = process.argv[2];
+
+//initalize the database
+var log4js = require("log4js");
+log4js.setGlobalLogLevel("INFO");
+var async = require("async");
+var db = require('../node/db/DB');
+var dirty = require("dirty")(padId + ".db");
+var padManager; 
+var pad;
+var neededDBValues = ["pad:"+padId];
+
+async.series([
+  //intallize the database
+  function (callback)
+  {
+    db.init(callback);
+  },
+  //get the pad 
+  function (callback)
+  {
+    padManager = require('../node/db/PadManager');
+    
+    padManager.getPad(padId, function(err, _pad)  
+    {
+      pad = _pad;
+      callback(err);
+    });
+  },
+  function (callback)
+  {
+    //add all authors
+    var authors = pad.getAllAuthors();
+    for(var i=0;i<authors.length;i++)
+    {
+      neededDBValues.push("globalAuthor:" + authors[i]);
+    }
+    
+    //add all revisions
+    var revHead = pad.head;
+    for(var i=0;i<=revHead;i++)
+    {
+      neededDBValues.push("pad:"+padId+":revs:" + i);
+    }
+    
+    //get all chat values
+    var chatHead = pad.chatHead;
+    for(var i=0;i<=chatHead;i++)
+    {
+      neededDBValues.push("pad:"+padId+":chat:" + i);
+    }
+    
+    //get and set all values
+    async.forEach(neededDBValues, function(dbkey, callback)
+    {
+      db.db.db.wrappedDB.get(dbkey, function(err, dbvalue)
+      {
+        if(err) { callback(err); return}
+        dbvalue=JSON.parse(dbvalue);
+        
+        dirty.set(dbkey, dbvalue, callback);
+      });
+    }, callback);
+  }
+], function (err)
+{
+  if(err) throw err;
+  else 
+  { 
+    console.log("finished");
+    process.exit();
+  }
+});
+
+//get the pad object
+//get all revisions of this pad
+//get all authors related to this pad
+//get the readonly link releated to this pad
+//get the chat entrys releated to this pad

bin/installDeps.sh

@@ -0,0 +1,102 @@
+#!/bin/sh
+
+#Move to the folder where ep-lite is installed
+cd `dirname $0`
+
+#Was this script started in the bin folder? if yes move out
+if [ -d "../bin" ]; then
+  cd "../"
+fi
+
+#Is wget installed?
+hash curl > /dev/null 2>&1 || { 
+  echo "Please install curl" >&2
+  exit 1 
+}
+
+#Is node installed?
+hash node > /dev/null 2>&1 || { 
+  echo "Please install node.js ( http://nodejs.org )" >&2
+  exit 1 
+}
+
+#Is npm installed?
+hash npm > /dev/null 2>&1 || { 
+  echo "Please install npm ( http://npmjs.org )" >&2
+  exit 1 
+}
+
+#check npm version
+NPM_VERSION=$(npm --version)
+if [ ! $(echo $NPM_VERSION | cut -d "." -f 1) = "1" ]; then
+  echo "You're running a wrong version of npm, you're using $NPM_VERSION, we need 1.x" >&2
+  exit 1 
+fi
+
+#check node version
+NODE_VERSION=$(node --version)
+NODE_V_MINOR=$(echo $NODE_VERSION | cut -d "." -f 1-2)
+if [ ! $NODE_V_MINOR = "v0.8" ] && [ ! $NODE_V_MINOR = "v0.6" ]; then
+  echo "You're running a wrong version of node, you're using $NODE_VERSION, we need v0.6.x or v0.8.x" >&2
+  exit 1 
+fi
+
+#Get the name of the settings file
+settings="settings.json"
+a='';
+for arg in $*; do
+  if [ "$a" = "--settings" ] || [ "$a" = "-s" ]; then settings=$arg; fi
+  a=$arg
+done
+
+#Does a $settings exist? if no copy the template
+if [ ! -f $settings ]; then
+  echo "Copy the settings template to $settings..."
+  cp -v settings.json.template $settings || exit 1
+fi
+
+echo "Ensure that all dependencies are up to date..."
+(
+  mkdir -p node_modules
+  cd node_modules
+  [ -e ep_etherpad-lite ] || ln -s ../src ep_etherpad-lite
+  cd ep_etherpad-lite
+  npm install
+) || { 
+  rm -rf node_modules
+  exit 1 
+}
+
+echo "Ensure jQuery is downloaded and up to date..."
+DOWNLOAD_JQUERY="true"
+NEEDED_VERSION="1.7.1"
+if [ -f "src/static/js/jquery.js" ]; then
+  VERSION=$(cat src/static/js/jquery.js | head -n 3 | grep -o "v[0-9]\.[0-9]\(\.[0-9]\)\?");
+  
+  if [ ${VERSION#v} = $NEEDED_VERSION ]; then
+    DOWNLOAD_JQUERY="false"
+  fi
+fi
+
+if [ $DOWNLOAD_JQUERY = "true" ]; then
+  curl -lo src/static/js/jquery.js http://code.jquery.com/jquery-$NEEDED_VERSION.js || exit 1
+fi
+
+#Remove all minified data to force node creating it new
+echo "Clear minfified cache..."
+rm -f var/minified*
+
+echo "ensure custom css/js files are created..."
+
+for f in "index" "pad" "timeslider"
+do
+  if [ ! -f "src/static/custom/$f.js" ]; then
+    cp -v "src/static/custom/js.template" "src/static/custom/$f.js" || exit 1
+  fi
+  
+  if [ ! -f "src/static/custom/$f.css" ]; then
+    cp -v "src/static/custom/css.template" "src/static/custom/$f.css" || exit 1
+  fi
+done
+
+exit 0

bin/installOnWindows.bat

@@ -0,0 +1,39 @@
+@echo off
+
+:: change directory to etherpad-lite root
+cd /D "%~dp0\.."
+
+:: Is node installed?
+cmd /C node -e "" || ( echo "Please install node.js ( http://nodejs.org )" && exit /B 1 )
+
+echo _
+echo Checking node version...
+set check_version="if(['6','8'].indexOf(process.version.split('.')[1].toString()) === -1) { console.log('You are running a wrong version of Node. Etherpad Lite requires v0.6.x or v0.8.x'); process.exit(1) }"
+cmd /C node -e %check_version% || exit /B 1
+
+echo _
+echo Installing etherpad-lite and dependencies...
+cmd /C npm install src/ || exit /B 1
+
+echo _
+echo Copying custom templates...
+set custom_dir=node_modules\ep_etherpad-lite\static\custom
+FOR %%f IN (index pad timeslider) DO (
+  if NOT EXIST "%custom_dir%\%%f.js" copy "%custom_dir%\js.template" "%custom_dir%\%%f.js"
+  if NOT EXIST "%custom_dir%\%%f.css" copy "%custom_dir%\css.template" "%custom_dir%\%%f.css"
+)
+
+echo _
+echo Clearing cache...
+del /S var\minified*
+
+echo _
+echo Setting up settings.json...
+IF NOT EXIST settings.json (
+  echo Can't find settings.json.
+  echo Copying settings.json.template...
+  cmd /C copy settings.json.template settings.json || exit /B 1
+)
+
+echo _
+echo Installed Etherpad-lite!  To run Etherpad type start.bat

bin/jshint.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+if [ -d "../bin" ]; then
+  cd "../"
+fi
+
+JSHINT=./node_modules/jshint/bin/hint
+
+$JSHINT ./node/

bin/loadTesting/README

@@ -0,0 +1,75 @@
+This load tester is extremely useful for testing how many dormant clients can connect to etherpad lite.  
+
+TODO:
+Emulate characters being typed into a pad
+
+HOW TO USE (from @mjd75) proper formatting at: https://github.com/Pita/etherpad-lite/issues/360
+
+Server 1:
+Installed Node.js (etc), EtherPad Lite and MySQL
+
+Server 2:
+Installed Xvfb and PhantomJS
+
+I installed Xvfb following (roughly) this guide: http://blog.martin-lyness.com/archives/installing-xvfb-on-ubuntu-9-10-karmic-koala
+
+	#sudo apt-get install xvfb
+	#sudo apt-get install xfonts-100dpi xfonts-75dpi xfonts-scalable xfonts-cyrillic   
+
+Launched two instances of Xvfb directly from the terminal:
+
+	#Xvfb :0 -ac
+	#Xvfb :1 -ac
+
+I installed PhantomJS following this guide: http://code.google.com/p/phantomjs/wiki/Installation
+
+	#sudo add-apt-repository ppa:jerome-etienne/neoip
+	#sudo apt-get update
+	#sudo apt-get install phantomjs
+
+I created a small JavaScript file for PhatomJS to use to control the browser instances:
+
+### BEGIN JAVASCRIPT ###
+
+var page = new WebPage(),
+    t, address;
+
+if (phantom.args.length === 0) {
+    console.log('Usage: loader.js <some URL>');
+    phantom.exit();
+} else {
+    t = Date.now();
+    address = phantom.args[0];
+
+    var page = new WebPage();
+    page.onResourceRequested = function (request) {
+        console.log('Request ' + JSON.stringify(request, undefined, 4));
+    };
+    page.onResourceReceived = function (response) {
+        console.log('Receive ' + JSON.stringify(response, undefined, 4));
+    };
+    page.open(address);
+
+}
+
+### END JAVASCRIPT ###
+
+And finally a launcher script that uses screen to run 400 instances of PhantomJS with the above script:
+
+### BEGIN SHELL SCRIPT ###
+
+#!/bin/bash     
+
+# connect 200 instances to display :0                                                             
+for i in {1..200}
+do
+  DISPLAY=:0 screen -d -m phantomjs loader.js http://ec2-50-17-168-xx.compute-1.amazonaws.com:9001/p/pad2 && sleep 2
+done
+
+# connect 200 instances to display :1                                                             
+for i in {1..200}
+do
+  DISPLAY=:1 screen -d -m phantomjs loader.js http://ec2-50-17-168-xx.compute-1.amazonaws.com:9001/p/pad2 && sleep 2
+done
+
+### END SHELL SCRIPT ###

bin/loadTesting/launcher.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# connect 500 instances to display :0
+for i in {1..500}
+do
+  echo 	$i
+  echo "Displaying Some shit"
+  DISPLAY=:0 screen -d -m /home/phantomjs/bin/phantomjs loader.js http://10.0.0.55:9001/p/pad2 && sleep 2
+done
+
+# connect 500 instances to display :1
+for i in {1..500}
+do
+  echo $i
+  DISPLAY=:1 screen -d -m /home/phantomjs/bin/phantomjs loader.js http://10.0.0.55:9001/p/pad2 && sleep 2
+done

bin/loadTesting/loader.js

@@ -0,0 +1,20 @@
+var page = new WebPage(),
+    t, address;
+
+if (phantom.args.length === 0) {
+    console.log('Usage: loader.js <some URL>');
+    phantom.exit();
+} else {
+    t = Date.now();
+    address = phantom.args[0];
+
+    var page = new WebPage();
+    page.onResourceRequested = function (request) {
+        console.log('Request ' + JSON.stringify(request, undefined, 4));
+    };
+    page.onResourceReceived = function (response) {
+        console.log('Receive ' + JSON.stringify(response, undefined, 4));
+    };
+    page.open(address);
+
+}

bin/run.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+#Move to the folder where ep-lite is installed
+cd `dirname $0`
+
+#Was this script started in the bin folder? if yes move out
+if [ -d "../bin" ]; then
+  cd "../"
+fi
+
+#Stop the script if its started as root
+if [ "$(id -u)" -eq 0 ]; then
+   echo "You shouldn't start Etherpad-Lite as root!"
+   echo "Please type 'Etherpad Lite rocks my socks' if you still want to start it as root"
+   read rocks
+   if [ ! $rocks = "Etherpad Lite rocks my socks" ]
+   then
+     echo "Your input was incorrect"
+     exit 1
+   fi
+fi
+
+#prepare the enviroment
+bin/installDeps.sh $* || exit 1
+
+#Move to the node folder and start
+echo "start..."
+node node_modules/ep_etherpad-lite/node/server.js $*

bin/safeRun.sh

@@ -0,0 +1,66 @@
+#!/bin/sh
+
+#This script ensures that ep-lite is automatically restarting after an error happens
+
+#Handling Errors
+# 0 silent
+# 1 email
+ERROR_HANDLING=0
+# Your email address which should recieve the error messages
+EMAIL_ADDRESS="no-reply@example.com"
+# Sets the minimun amount of time betweens the sending of error emails. 
+# This ensures you not get spamed while a endless reboot loop 
+# It's the time in seconds
+TIME_BETWEEN_EMAILS=600 # 10 minutes
+
+# DON'T EDIT AFTER THIS LINE
+
+LAST_EMAIL_SEND=0
+
+#Move to the folder where ep-lite is installed
+cd `dirname $0`
+
+#Was this script started in the bin folder? if yes move out
+if [ -d "../bin" ]; then
+  cd "../"
+fi
+
+#check if a logfile parameter is set
+if [ -z "$1" ]; then
+  echo "Set a logfile as the first parameter"
+  exit 1
+fi
+
+while [ 1 ]
+do
+  #try to touch the file if it doesn't exist
+  if [ ! -f $1 ]; then
+    touch $1 || ( echo "Logfile '$1' is not writeable" && exit 1 )
+  fi
+  
+  #check if the file is writeable
+  if [ ! -w $1 ]; then
+    echo "Logfile '$1' is not writeable"
+    exit 1
+  fi
+
+  #start the application
+  bin/run.sh >>$1 2>>$1
+  
+  #Send email
+  if [ $ERROR_HANDLING = 1 ]; then
+    TIME_NOW=$(date +%s)
+    TIME_SINCE_LAST_SEND=$(($TIME_NOW - $LAST_EMAIL_SEND))
+    
+    if [ $TIME_SINCE_LAST_SEND -gt $TIME_BETWEEN_EMAILS ]; then
+      printf "Server was restared at: $(date)\nThe last 50 lines of the log before the error happens:\n $(tail -n 50 $1)" | mail -s "Pad Server was restarted" $EMAIL_ADDRESS
+      
+      LAST_EMAIL_SEND=$TIME_NOW
+    fi
+  fi
+  
+  echo "RESTART!" >>$1
+  
+  #Sleep 10 seconds before restart
+  sleep 10
+done

doc/all.md

@@ -0,0 +1,3 @@
+@include documentation
+@include api/api
+@include database

doc/api/api.adoc

@@ -1,19 +0,0 @@
-include::./embed_parameters.adoc[]
-
-include::./http_api.adoc[]
-
-include::./hooks_overview.adoc[]
-
-include::./hooks_client-side.adoc[]
-
-include::./hooks_server-side.adoc[]
-
-include::./editorInfo.adoc[]
-
-include::./changeset_library.adoc[]
-
-include::./pluginfw.adoc[]
-
-include::./toolbar.adoc[]
-
-include::./editbar.adoc[]

doc/api/api.md

@@ -0,0 +1,7 @@
+@include embed_parameters
+@include http_api
+@include hooks
+@include hooks_client-side
+@include hooks_server-side
+@include editorInfo
+@include changeset_library

doc/api/changeset_library.adoc

@@ -1,46 +0,0 @@
-== Changeset Library
-
-The https://github.com/ether/etherpad-lite/blob/develop/src/static/js/Changeset.js[changeset
-library]
-provides tools to create, read, and apply changesets.
-
-=== Changeset
-
-[source,javascript]
-----
-const Changeset = require('ep_etherpad-lite/static/js/Changeset');
-----
-
-A changeset describes the difference between two revisions of a document. When a
-user edits a pad, the browser generates and sends a changeset to the server,
-which relays it to the other users and saves a copy (so that every past revision
-is accessible).
-
-A transmitted changeset looks like this:
-
-[source]
-----
-'Z:z>1|2=m=b*0|1+1$\n'
-----
-
-=== Attribute Pool
-
-[source,javascript]
-----
-const AttributePool = require('ep_etherpad-lite/static/js/AttributePool');
-----
-
-Changesets do not include any attribute key–value pairs. Instead, they use
-numeric identifiers that reference attributes kept in an https://github.com/ether/etherpad-lite/blob/develop/src/static/js/AttributePool.js[attribute pool].
-This attribute interning reduces the transmission overhead of attributes that
-are used many times.
-
-There is one attribute pool per pad, and it includes every current and
-historical attribute used in the pad.
-
-=== Further Reading
-
-Detailed information about the changesets & Easysync protocol:
-
-* https://github.com/ether/etherpad-lite/blob/develop/doc/easysync/easysync-notes.pdf[Easysync Protocol]
-* https://github.com/ether/etherpad-lite/blob/develop/doc/easysync/easysync-full-description.pdf[Etherpad and EasySync Technical Manual]

doc/api/changeset_library.md

@@ -0,0 +1,151 @@
+# Changeset Library
+
+```
+"Z:z>1|2=m=b*0|1+1$\n"
+```
+
+This is a Changeset. Its just a string and its very difficult to read in this form. But the Changeset Library gives us some tools to read it.
+
+A changeset describes the diff between two revisions of the document. The Browser sends changesets to the server and the server sends them to the clients to update them. This Changesets gets also saved into the history of a pad. Which allows us to go back to every revision from the past.
+
+## Changeset.unpack(changeset)
+
+ * `changeset` {String}
+
+This functions returns an object representaion of the changeset, similar to this:
+
+```
+{ oldLen: 35, newLen: 36, ops: '|2=m=b*0|1+1', charBank: '\n' }
+```
+
+ * `oldLen` {Number} the original length of the document.
+ * `newLen` {Number} the length of the document after the changeset is applied.
+ * `ops` {String} the actual changes, introduced by this changeset.
+ * `charBank` {String} All characters that are added by this changeset.
+
+## Changeset.opIterator(ops)
+
+ * `ops` {String} The operators, returned by `Changeset.unpack()`
+
+Returns an operator iterator. This iterator allows us to iterate over all operators that are in the changeset.
+
+You can iterate with an opIterator using its `next()` and `hasNext()` methods. Next returns the `next()` operator object and `hasNext()` indicates, whether there are any operators left.
+
+## The Operator object
+There are 3 types of operators: `+`,`-` and `=`. These operators describe different changes to the document, beginning with the first character of the document. A `=` operator doesn't change the text, but it may add or remove text attributes. A `-` operator removes text. And a `+` Operator adds text and optionally adds some attributes to it.
+
+ * `opcode` {String} the operator type
+ * `chars` {Number} the length of the text changed by this operator.
+ * `lines` {Number} the number of lines changed by this operator.
+ * `attribs` {attribs} attributes set on this text.
+
+### Example
+```
+{ opcode: '+',
+  chars: 1,
+  lines: 1,
+  attribs: '*0' }
+```
+
+## APool
+
+```
+> var AttributePoolFactory = require("./utils/AttributePoolFactory");
+> var apool = AttributePoolFactory.createAttributePool();
+> console.log(apool)
+{ numToAttrib: {},
+  attribToNum: {},
+  nextNum: 0,
+  putAttrib: [Function],
+  getAttrib: [Function],
+  getAttribKey: [Function],
+  getAttribValue: [Function],
+  eachAttrib: [Function],
+  toJsonable: [Function],
+  fromJsonable: [Function] }
+```
+
+This creates an empty apool. A apool saves which attributes were used during the history of a pad. There is one apool for each pad. It only saves the attributes that were really used, it doesn't save unused attributes. Lets fill this apool with some values
+
+```
+> apool.fromJsonable({"numToAttrib":{"0":["author","a.kVnWeomPADAT2pn9"],"1":["bold","true"],"2":["italic","true"]},"nextNum":3});
+> console.log(apool)
+{ numToAttrib: 
+   { '0': [ 'author', 'a.kVnWeomPADAT2pn9' ],
+     '1': [ 'bold', 'true' ],
+     '2': [ 'italic', 'true' ] },
+  attribToNum: 
+   { 'author,a.kVnWeomPADAT2pn9': 0,
+     'bold,true': 1,
+     'italic,true': 2 },
+  nextNum: 3,
+  putAttrib: [Function],
+  getAttrib: [Function],
+  getAttribKey: [Function],
+  getAttribValue: [Function],
+  eachAttrib: [Function],
+  toJsonable: [Function],
+  fromJsonable: [Function] }
+```
+
+We used the fromJsonable function to fill the empty apool with values. the fromJsonable and toJsonable functions are used to serialize and deserialize an apool. You can see that it stores the relation between numbers and attributes. So for example the attribute 1 is the attribute bold and vise versa. A attribute is always a key value pair. For stuff like bold and italic its just  'italic':'true'. For authors its author:$AUTHORID. So a character can be bold and italic. But it can't belong to multiple authors
+
+```
+> apool.getAttrib(1)
+[ 'bold', 'true' ]
+```
+
+Simple example of how to get the key value pair for the attribute 1
+
+## AText
+
+```
+> var atext = {"text":"bold text\nitalic text\nnormal text\n\n","attribs":"*0*1+9*0|1+1*0*1*2+b|1+1*0+b|2+2"};
+> console.log(atext)
+{ text: 'bold text\nitalic text\nnormal text\n\n',
+  attribs: '*0*1+9*0|1+1*0*1*2+b|1+1*0+b|2+2' }
+```
+
+This is an atext. An atext has two parts: text and attribs. The text is just the text of the pad as a string. We will look closer at the attribs at the next steps
+
+```
+> var opiterator = Changeset.opIterator(atext.attribs)
+> console.log(opiterator)
+{ next: [Function: next],
+  hasNext: [Function: hasNext],
+  lastIndex: [Function: lastIndex] }
+> opiterator.next()
+{ opcode: '+',
+  chars: 9,
+  lines: 0,
+  attribs: '*0*1' }
+> opiterator.next()
+{ opcode: '+',
+  chars: 1,
+  lines: 1,
+  attribs: '*0' }
+> opiterator.next()
+{ opcode: '+',
+  chars: 11,
+  lines: 0,
+  attribs: '*0*1*2' }
+> opiterator.next()
+{ opcode: '+',
+  chars: 1,
+  lines: 1,
+  attribs: '' }
+> opiterator.next()
+{ opcode: '+',
+  chars: 11,
+  lines: 0,
+  attribs: '*0' }
+> opiterator.next()
+{ opcode: '+',
+  chars: 2,
+  lines: 2,
+  attribs: '' }
+```
+
+The attribs are again a bunch of operators like .ops in the changeset was. But these operators are only + operators. They describe which part of the text has which attributes
+
+For more information see /doc/easysync/easysync-notes.txt in the source.

doc/api/editbar.adoc

@@ -1,30 +0,0 @@
-== Editbar
-src/static/js/pad_editbar.js
-
-=== isEnabled()
-
-=== disable()
-
-=== toggleDropDown(dropdown)
-Shows the dropdown `div.popup` whose `id` equals `dropdown`.
-
-=== registerCommand(cmd, callback)
-Register a handler for a specific command. Commands are fired if the corresponding button is clicked or the corresponding select is changed.
-
-=== registerAceCommand(cmd, callback)
-Creates an ace callstack and calls the callback with an ace instance (and a toolbar item, if applicable): `callback(cmd, ace, item)`.
-
-Example:
-
-[source, javascript]
-----
-toolbar.registerAceCommand("insertorderedlist", function (cmd, ace) {
-  ace.ace_doInsertOrderedList();
-});
-----
-
-=== registerDropdownCommand(cmd, dropdown)
-Ties a `div.popup` where `id` equals `dropdown` to a `command` fired by clicking a button.
-
-=== triggerCommand(cmd[, item])
-Triggers a command (optionally with some internal representation of the toolbar item that triggered it).

doc/api/editorInfo.adoc

@@ -1,125 +0,0 @@
-== editorInfo
-
-=== editorInfo.ace_replaceRange(start, end, text)
-This function replaces a range (from `start` to `end`) with `text`.
-
-=== editorInfo.ace_getRep()
-Returns the `rep` object.
-
-=== editorInfo.ace_getAuthor()
-
-=== editorInfo.ace_inCallStack()
-
-=== editorInfo.ace_inCallStackIfNecessary(?)
-
-=== editorInfo.ace_focus(?)
-
-=== editorInfo.ace_importText(?)
-
-=== editorInfo.ace_importAText(?)
-
-=== editorInfo.ace_exportText(?)
-
-=== editorInfo.ace_editorChangedSize(?)
-
-=== editorInfo.ace_setOnKeyPress(?)
-
-=== editorInfo.ace_setOnKeyDown(?)
-
-=== editorInfo.ace_setNotifyDirty(?)
-
-=== editorInfo.ace_dispose(?)
-
-=== editorInfo.ace_setEditable(bool)
-
-=== editorInfo.ace_execCommand(?)
-
-=== editorInfo.ace_callWithAce(fn, callStack, normalize)
-
-=== editorInfo.ace_setProperty(key, value)
-
-=== editorInfo.ace_setBaseText(txt)
-
-=== editorInfo.ace_setBaseAttributedText(atxt, apoolJsonObj)
-
-=== editorInfo.ace_applyChangesToBase(c, optAuthor, apoolJsonObj)
-
-=== editorInfo.ace_prepareUserChangeset()
-
-=== editorInfo.ace_applyPreparedChangesetToBase()
-
-=== editorInfo.ace_setUserChangeNotificationCallback(f)
-
-=== editorInfo.ace_setAuthorInfo(author, info)
-
-=== editorInfo.ace_fastIncorp(?)
-
-=== editorInfo.ace_isCaret(?)
-
-=== editorInfo.ace_getLineAndCharForPoint(?)
-
-=== editorInfo.ace_performDocumentApplyAttributesToCharRange(?)
-
-=== editorInfo.ace_setAttributeOnSelection(attribute, enabled)
-
-Sets an attribute on current range.
-Example: `call.editorInfo.ace_setAttributeOnSelection("turkey::balls", true); // turkey is the attribute here, balls is the value
-Notes: to remove the attribute pass enabled as false
-
-=== editorInfo.ace_toggleAttributeOnSelection(?)
-
-=== editorInfo.ace_getAttributeOnSelection(attribute, prevChar)
-Returns a boolean if an attribute exists on a selected range.
-prevChar value should be true if you want to get the previous Character attribute instead of the current selection for example
-if the caret is at position 0,1 (after first character) it's probable you want the attributes on the character at 0,0
-The attribute should be the string name of the attribute applied to the selection IE subscript
-Example usage: Apply the activeButton Class to a button if an attribute is on a highlighted/selected caret position or range.
-Example `var isItThere = documentAttributeManager.getAttributeOnSelection("turkey::balls", true);`
-
-See the ep_subscript plugin for an example of this function in action.
-Notes: Does not work on first or last character of a line.  Suffers from a race condition if called with aceEditEvent.
-
-=== editorInfo.ace_performSelectionChange(?)
-
-=== editorInfo.ace_doIndentOutdent(?)
-
-=== editorInfo.ace_doUndoRedo(?)
-
-=== editorInfo.ace_doInsertUnorderedList(?)
-
-=== editorInfo.ace_doInsertOrderedList(?)
-
-=== editorInfo.ace_performDocumentApplyAttributesToRange()
-
-=== editorInfo.ace_getAuthorInfos()
-Returns an info object about the author. Object key = author_id and info includes author's bg color value.
-Use to define your own authorship.
-
-=== editorInfo.ace_performDocumentReplaceRange(start, end, newText)
-This function replaces a range (from [x1,y1] to [x2,y2]) with `newText`.
-
-=== editorInfo.ace_performDocumentReplaceCharRange(startChar, endChar, newText)
-This function replaces a range (from y1 to y2) with `newText`.
-
-=== editorInfo.ace_renumberList(lineNum)
-If you delete a line, calling this method will fix the line numbering.
-
-=== editorInfo.ace_doReturnKey()
-Forces a return key at the current caret position.
-
-=== editorInfo.ace_isBlockElement(element)
-Returns true if your passed element is registered as a block element
-
-=== editorInfo.ace_getLineListType(lineNum)
-Returns the line's html list type.
-
-=== editorInfo.ace_caretLine()
-Returns X position of the caret.
-
-=== editorInfo.ace_caretColumn()
-Returns Y position of the caret.
-
-=== editorInfo.ace_caretDocChar()
-Returns the Y offset starting from [x=0,y=0]
-
-=== editorInfo.ace_isWordChar(?)

doc/api/editorInfo.md

@@ -0,0 +1,47 @@
+# editorInfo
+
+## editorInfo.ace_replaceRange(start, end, text)
+This function replaces a range (from `start` to `end`) with `text`.
+
+## editorInfo.ace_getRep()
+Returns the `rep` object.
+
+## editorInfo.ace_getAuthor()
+## editorInfo.ace_inCallStack()
+## editorInfo.ace_inCallStackIfNecessary(?)
+## editorInfo.ace_focus(?)
+## editorInfo.ace_importText(?)
+## editorInfo.ace_importAText(?)
+## editorInfo.ace_exportText(?)
+## editorInfo.ace_editorChangedSize(?)
+## editorInfo.ace_setOnKeyPress(?)
+## editorInfo.ace_setOnKeyDown(?)
+## editorInfo.ace_setNotifyDirty(?)
+## editorInfo.ace_dispose(?)
+## editorInfo.ace_getFormattedCode(?)
+## editorInfo.ace_setEditable(bool)
+## editorInfo.ace_execCommand(?)
+## editorInfo.ace_callWithAce(fn, callStack, normalize)
+## editorInfo.ace_setProperty(key, value)
+## editorInfo.ace_setBaseText(txt)
+## editorInfo.ace_setBaseAttributedText(atxt, apoolJsonObj)
+## editorInfo.ace_applyChangesToBase(c, optAuthor, apoolJsonObj)
+## editorInfo.ace_prepareUserChangeset()
+## editorInfo.ace_applyPreparedChangesetToBase()
+## editorInfo.ace_setUserChangeNotificationCallback(f)
+## editorInfo.ace_setAuthorInfo(author, info)
+## editorInfo.ace_setAuthorSelectionRange(author, start, end)
+## editorInfo.ace_getUnhandledErrors()
+## editorInfo.ace_getDebugProperty(prop)
+## editorInfo.ace_fastIncorp(?)
+## editorInfo.ace_isCaret(?)
+## editorInfo.ace_getLineAndCharForPoint(?)
+## editorInfo.ace_performDocumentApplyAttributesToCharRange(?)
+## editorInfo.ace_setAttributeOnSelection(?)
+## editorInfo.ace_toggleAttributeOnSelection(?)
+## editorInfo.ace_performSelectionChange(?)
+## editorInfo.ace_doIndentOutdent(?)
+## editorInfo.ace_doUndoRedo(?)
+## editorInfo.ace_doInsertUnorderedList(?)
+## editorInfo.ace_doInsertOrderedList(?)
+## editorInfo.ace_performDocumentApplyAttributesToRange()

doc/api/embed_parameters.adoc

@@ -1,76 +0,0 @@
-== Embed parameters
-You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed parameters.
-
-Example:
-
-Cut and paste the following code into any webpage to embed a pad. The parameters below will hide the chat and the line numbers and will auto-focus on Line 4.
-
-[source, html]
-----
-<iframe src='http://pad.test.de/p/PAD_NAME#L4?showChat=false&showLineNumbers=false' width=600 height=400></iframe>
-----
-
-=== showLineNumbers
- * Boolean
-
-Default: true
-
-=== showControls
- * Boolean
-
-Default: true
-
-=== showChat
- * Boolean
-
-Default: true
-
-=== useMonospaceFont
- * Boolean
-
-Default: false
-
-=== userName
- * String
-
-Default: "unnamed"
-
-Example: `userName=Etherpad%20User`
-
-=== userColor
- * String (css hex color value)
-
-Default: randomly chosen by pad server
-
-Example: `userColor=%23ff9900`
-
-=== noColors
- * Boolean
-
-Default: false
-
-=== alwaysShowChat
- * Boolean
-
-Default: false
-
-=== lang
- * String
-
-Default: en
-
-Example: `lang=ar` (translates the interface into Arabic)
-
-=== rtl
- * Boolean
-
-Default: true
-Displays pad text from right to left.
-
-=== #L
- * Int
-
-Default: 0
-Focuses pad at specific line number and places caret at beginning of this line
-Special note: Is not a URL parameter but instead of a Hash value
-

doc/api/embed_parameters.md

@@ -0,0 +1,47 @@
+# Embed parameters
+You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed paramters.
+
+Example:
+
+Cut and paste the following code into any webpage to embed a pad. The parameters below will hide the chat and the line numbers.
+
+```
+<iframe src='http://pad.test.de/p/PAD_NAME?showChat=false&showLineNumbers=false' width=600 height=400></iframe>
+```
+
+## showLineNumbers
+ * Boolean
+
+Default: true
+
+## showControls
+ * Boolean
+
+Default: true
+
+## showChat
+ * Boolean
+
+Default: true
+
+## useMonospaceFont
+ * Boolean
+
+Default: false
+
+## userName
+ * String
+
+Default: "unnamed"
+
+Example: `userName=Etherpad%20User`
+
+## noColors
+ * Boolean
+
+Default: false
+
+## alwaysShowChat
+ * Boolean
+
+Default: false

doc/api/hooks.md

@@ -0,0 +1,11 @@
+# Hooks
+All hooks are called with two arguments:
+
+1. name - the name of the hook being called
+2. context - an object with some relevant information about the context of the call
+
+## Return values
+A hook should always return a list or undefined. Returning undefined is equivalent to returning an empty list.
+All the returned lists are appended to each other, so if the return values where `[1, 2]`, `undefined`, `[3, 4,]`, `undefined` and `[5]`, the value returned by callHook would be `[1, 2, 3, 4, 5]`.
+
+This is, because it should never matter if you have one plugin or several plugins doing some work - a single plugin should be able to make callHook return the same value a set of plugins are able to return collectively. So, any plugin can return a list of values, of any length, not just one value.

doc/api/hooks_client-side.adoc

@@ -1,533 +0,0 @@
-== Client-side hooks
-
-Most of these hooks are called during or in order to set up the formatting
-process.
-
-=== documentReady
-Called from: src/templates/pad.html
-
-Things in context:
-
-nothing
-
-This hook proxies the functionality of jQuery's `$(document).ready` event.
-
-=== aceDomLinePreProcessLineAttributes
-
-Called from: src/static/js/domline.js
-
-Things in context:
-
-1. domline - The current DOM line being processed
-2. cls - The class of the current block element (useful for styling)
-
-This hook is called for elements in the DOM that have the "lineMarkerAttribute"
-set. You can add elements into this category with the aceRegisterBlockElements
-hook above. This hook is run BEFORE the numbered and ordered lists logic is
-applied.
-
-The return value of this hook should have the following structure:
-
-`{ preHtml: String, postHtml: String, processedMarker: Boolean }`
-
-The preHtml and postHtml values will be added to the HTML display of the
-element, and if processedMarker is true, the engine won't try to process it any
-more.
-
-=== aceDomLineProcessLineAttributes
-
-Called from: src/static/js/domline.js
-
-Things in context:
-
-1. domline - The current DOM line being processed
-2. cls - The class of the current block element (useful for styling)
-
-This hook is called for elements in the DOM that have the "lineMarkerAttribute"
-set. You can add elements into this category with the aceRegisterBlockElements
-hook above. This hook is run AFTER the ordered and numbered lists logic is
-applied.
-
-The return value of this hook should have the following structure:
-
-`{ preHtml: String, postHtml: String, processedMarker: Boolean }`
-
-The preHtml and postHtml values will be added to the HTML display of the
-element, and if processedMarker is true, the engine won't try to process it any
-more.
-
-=== aceCreateDomLine
-
-Called from: src/static/js/domline.js
-
-Things in context:
-
-1. domline - the current DOM line being processed
-2. cls - The class of the current element (useful for styling)
-
-This hook is called for any line being processed by the formatting engine,
-unless the aceDomLineProcessLineAttributes hook from above returned true, in
-which case this hook is skipped.
-
-The return value of this hook should have the following structure:
-
-`{ extraOpenTags: String, extraCloseTags: String, cls: String }`
-
-extraOpenTags and extraCloseTags will be added before and after the element in
-question, and cls will be the new class of the element going forward.
-
-=== acePostWriteDomLineHTML
-
-Called from: src/static/js/domline.js
-
-Things in context:
-
-1. node - the DOM node that just got written to the page
-
-This hook is for right after a node has been fully formatted and written to the
-page.
-
-=== aceAttribsToClasses
-
-Called from: src/static/js/linestylefilter.js
-
-Things in context:
-
-1. linestylefilter - the JavaScript object that's currently processing the ace
-   attributes
-2. key - the current attribute being processed
-3. value - the value of the attribute being processed
-
-This hook is called during the attribute processing procedure, and should be
-used to translate key, value pairs into valid HTML classes that can be inserted
-into the DOM.
-
-The return value for this function should be a list of classes, which will then
-be parsed into a valid class string.
-
-=== aceAttribClasses
-
-Called from: src/static/js/linestylefilter.js
-
-Things in context:
-1. Attributes - Object of Attributes
-
-This hook is called when attributes are investigated on a line. It is useful if
-you want to add another attribute type or property type to a pad.
-
-Example:
-
-[source,javascript]
-----
-exports.aceAttribClasses = function(hook_name, attr, cb){
-  attr.sub = 'tag:sub';
-  cb(attr);
-}
-----
-
-=== aceGetFilterStack
-
-Called from: src/static/js/linestylefilter.js
-
-Things in context:
-
-1. linestylefilter - the JavaScript object that's currently processing the ace
-   attributes
-2. browser - an object indicating which browser is accessing the page
-
-This hook is called to apply custom regular expression filters to a set of
-styles. The one example available is the ep_linkify plugin, which adds internal
-links. They use it to find the telltale `[[ ]]` syntax that signifies internal
-links, and finding that syntax, they add in the internalHref attribute to be
-later used by the aceCreateDomLine hook (documented above).
-
-=== aceEditorCSS
-
-Called from: src/static/js/ace.js
-
-Things in context: None
-
-This hook is provided to allow custom CSS files to be loaded. The return value
-should be an array of resource urls or paths relative to the plugins directory.
-
-=== aceInitInnerdocbodyHead
-
-Called from: src/static/js/ace.js
-
-Things in context:
-
-1. iframeHTML - the HTML of the editor iframe up to this point, in array format
-
-This hook is called during the creation of the editor HTML. The array should
-have lines of HTML added to it, giving the plugin author a chance to add in
-meta, script, link, and other tags that go into the `<head>` element of the
-editor HTML document.
-
-=== aceEditEvent
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context:
-
-1. callstack - a bunch of information about the current action
-2. editorInfo - information about the user who is making the change
-3. rep - information about where the change is being made
-4. documentAttributeManager - information about attributes in the document (this
-   is a mystery to me)
-
-This hook is made available to edit the edit events that might occur when
-changes are made. Currently you can change the editor information, some of the
-meanings of the edit, and so on. You can also make internal changes (internal to
-your plugin) that use the information provided by the edit event.
-
-=== aceRegisterNonScrollableEditEvents
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context: None
-
-When aceEditEvent (documented above) finishes processing the event, it scrolls
-the viewport to make caret visible to the user, but if you don't want that
-behavior to happen you can use this hook to register which edit events should
-not scroll viewport. The return value of this hook should be a list of event
-names.
-
-Example:
-
-[source, javascript]
-----
-exports.aceRegisterNonScrollableEditEvents = function(){
-  return [ 'repaginate', 'updatePageCount' ];
-}
-----
-
-=== aceRegisterBlockElements
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context: None
-
-The return value of this hook will add elements into the "lineMarkerAttribute"
-category, making the aceDomLineProcessLineAttributes hook (documented below)
-call for those elements.
-
-=== aceInitialized
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context:
-
-1. editorInfo - information about the user who will be making changes through
-   the interface, and a way to insert functions into the main ace object (see
-   ep_headings)
-2. rep - information about where the user's cursor is
-3. documentAttributeManager - some kind of magic
-
-This hook is for inserting further information into the ace engine, for later
-use in formatting hooks.
-
-=== postAceInit
-
-Called from: src/static/js/pad.js
-
-Things in context:
-
-1. ace - the ace object that is applied to this editor.
-2. clientVars - Object containing client-side configuration such as author ID
-   and plugin settings. Your plugin can manipulate this object via the
-   `clientVars` server-side hook.
-3. pad - the pad object of the current pad.
-
-=== postToolbarInit
-
-Called from: src/static/js/pad_editbar.js
-
-Things in context:
-
-1. ace - the ace object that is applied to this editor.
-2. toolbar - Editbar instance. See below for the Editbar documentation.
-
-Can be used to register custom actions to the toolbar.
-
-Usage examples:
-
-* https://github.com/tiblu/ep_authorship_toggle
-
-=== postTimesliderInit
-
-Called from: src/static/js/timeslider.js
-
-There doesn't appear to be any example available of this particular hook being
-used, but it gets fired after the timeslider is all set up.
-
-=== goToRevisionEvent
-
-Called from: src/static/js/broadcast.js
-
-Things in context:
-
-1. rev - The newRevision
-
-This hook gets fired both on timeslider load (as timeslider shows a new
-revision) and when the new revision is showed to a user. There doesn't appear to
-be any example available of this particular hook being used.
-
-=== userJoinOrUpdate
-
-Called from: src/static/js/pad_userlist.js
-
-Things in context:
-
-1. info - the user information
-
-This hook is called on the client side whenever a user joins or changes. This
-can be used to create notifications or an alternate user list.
-
-=== chatNewMessage
-
-Called from: `src/static/js/chat.js`
-
-This hook runs on the client side whenever a chat message is received from the
-server. It can be used to create different notifications for chat messages. Hook
-functions can modify the `author`, `authorName`, `duration`, `rendered`,
-`sticky`, `text`, and `timeStr` context properties to change how the message is
-processed. The `text` and `timeStr` properties may contain HTML and come
-pre-sanitized; plugins should be careful to sanitize any added user input to
-avoid introducing an XSS vulnerability.
-
-Context properties:
-
-* `authorName`: The display name of the user that wrote the message.
-* `author`: The author ID of the user that wrote the message.
-* `text`: Sanitized message HTML, with URLs wrapped like `<a
-  href="url">url</a>`. (Note that `message.text` is not sanitized or processed
-  in any way.)
-* `message`: The raw message object as received from the server, except with
-  time correction and a default `authorId` property if missing. Plugins must not
-  modify this object. Warning: Unlike `text`, `message.text` is not
-  pre-sanitized or processed in any way.
-* `rendered` - Used to override the default message rendering. Initially set to
-  `null`. If the hook function sets this to a DOM element object or a jQuery
-  object, then that object will be used as the rendered message UI. Otherwise,
-  if this is set to `null`, then Etherpad will render a default UI for the
-  message using the other context properties.
-* `sticky` (boolean): Whether the gritter notification should fade out on its
-  own or just sit there until manually closed.
-* `timestamp`: When the chat message was sent (milliseconds since epoch),
-  corrected using the difference between the local clock and the server's clock.
-* `timeStr`: The message timestamp as a formatted string.
-* `duration`: How long (in milliseconds) to display the gritter notification (0
-  to disable).
-
-=== chatSendMessage
-
-Called from: `src/static/js/chat.js`
-
-This hook runs on the client side whenever the user sends a new chat message.
-Plugins can mutate the message object to change the message text or add metadata
-to control how the message will be rendered by the `chatNewMessage` hook.
-
-Context properties:
-
-* `message`: The message object that will be sent to the Etherpad server.
-
-=== collectContentPre
-
-Called from: src/static/js/contentcollector.js
-
-Things in context:
-
-1. cc - the contentcollector object
-2. state - the current state of the change being made
-3. tname - the tag name of this node currently being processed
-4. styl - the style applied to the node (probably CSS) -- Note the typo
-5. cls - the HTML class string of the node
-
-This hook is called before the content of a node is collected by the usual
-methods. The cc object can be used to do a bunch of things that modify the
-content of the pad. See, for example, the heading1 plugin for etherpad original.
-
-E.g. if you need to apply an attribute to newly inserted characters, call
-cc.doAttrib(state, "attributeName") which results in an attribute
-attributeName=true.
-
-If you want to specify also a value, call cc.doAttrib(state,
-"attributeName::value") which results in an attribute attributeName=value.
-
-
-=== collectContentImage
-
-Called from: src/static/js/contentcollector.js
-
-Things in context:
-
-1. cc - the contentcollector object
-2. state - the current state of the change being made
-3. tname - the tag name of this node currently being processed
-4. style - the style applied to the node (probably CSS)
-5. cls - the HTML class string of the node
-6. node - the node being modified
-
-This hook is called before the content of an image node is collected by the
-usual methods. The cc object can be used to do a bunch of things that modify the
-content of the pad.
-
-Example:
-
-[source, javascript]
-----
-exports.collectContentImage = function(name, context){
-  context.state.lineAttributes.img = context.node.outerHTML;
-}
-
-----
-
-=== collectContentPost
-
-Called from: src/static/js/contentcollector.js
-
-Things in context:
-
-1. cc - the contentcollector object
-2. state - the current state of the change being made
-3. tname - the tag name of this node currently being processed
-4. style - the style applied to the node (probably CSS)
-5. cls - the HTML class string of the node
-
-This hook is called after the content of a node is collected by the usual
-methods. The cc object can be used to do a bunch of things that modify the
-content of the pad. See, for example, the heading1 plugin for etherpad original.
-
-=== handleClientMessage_`name`
-
-Called from: `src/static/js/collab_client.js`
-
-Things in context:
-
-1. payload - the data that got sent with the message (use it for custom message
-   content)
-
-This hook gets called every time the client receives a message of type `name`.
-This can most notably be used with the new HTTP API call, "sendClientsMessage",
-which sends a custom message type to all clients connected to a pad. You can
-also use this to handle existing types.
-
-`collab_client.js` has a pretty extensive list of message types, if you want to
-take a look.
-
-=== aceStartLineAndCharForPoint-aceEndLineAndCharForPoint
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context:
-
-1. callstack - a bunch of information about the current action
-2. editorInfo - information about the user who is making the change
-3. rep - information about where the change is being made
-4. root - the span element of the current line
-5. point - the starting/ending element where the cursor highlights
-6. documentAttributeManager - information about attributes in the document
-
-This hook is provided to allow a plugin to turn DOM node selection into
-[line,char] selection. The return value should be an array of [line,char]
-
-=== aceKeyEvent
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context:
-
-1. callstack - a bunch of information about the current action
-2. editorInfo - information about the user who is making the change
-3. rep - information about where the change is being made
-4. documentAttributeManager - information about attributes in the document
-5. evt - the fired event
-
-This hook is provided to allow a plugin to handle key events.
-The return value should be true if you have handled the event.
-
-=== collectContentLineText
-
-Called from: src/static/js/contentcollector.js
-
-Things in context:
-
-1. cc - the contentcollector object
-2. state - the current state of the change being made
-3. tname - the tag name of this node currently being processed
-4. text - the text for that line
-
-This hook allows you to validate/manipulate the text before it's sent to the
-server side. To change the text, either:
-
-* Set the `text` context property to the desired value and return `undefined`.
-* (Deprecated) Return a string. If a hook function changes the `text` context
-  property, the return value is ignored. If no hook function changes `text` but
-  multiple hook functions return a string, the first one wins.
-
-Example:
-
-[source,javascript]
-----
-exports.collectContentLineText = (hookName, context) => {
-  context.text = tweakText(context.text);
-};
-----
-
-=== collectContentLineBreak
-
-Called from: src/static/js/contentcollector.js
-
-Things in context:
-
-1. cc - the contentcollector object
-2. state - the current state of the change being made
-3. tname - the tag name of this node currently being processed
-
-This hook is provided to allow whether the br tag should induce a new magic
-domline or not. The return value should be either true(break the line) or false.
-
-=== disableAuthorColorsForThisLine
-
-Called from: src/static/js/linestylefilter.js
-
-Things in context:
-
-1. linestylefilter - the JavaScript object that's currently processing the ace
-   attributes
-2. text - the line text
-3. class - line class
-
-This hook is provided to allow whether a given line should be deliniated with
-multiple authors. Multiple authors in one line cause the creation of magic span
-lines. This might not suit you and now you can disable it and handle your own
-deliniation. The return value should be either true(disable) or false.
-
-=== aceSetAuthorStyle
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context:
-
-1. dynamicCSS - css manager for inner ace
-2. outerDynamicCSS - css manager for outer ace
-3. parentDynamicCSS - css manager for parent document
-4. info - author style info
-5. author - author info
-6. authorSelector - css selector for author span in inner ace
-
-This hook is provided to allow author highlight style to be modified. Registered
-hooks should return 1 if the plugin handles highlighting. If no plugin returns
-1, the core will use the default background-based highlighting.
-
-=== aceSelectionChanged
-
-Called from: src/static/js/ace2_inner.js
-
-Things in context:
-
-1. rep - information about where the user's cursor is
-2. documentAttributeManager - information about attributes in the document
-
-This hook allows a plugin to react to a cursor or selection change,
-perhaps to update a UI element based on the style at the cursor location.

doc/api/hooks_client-side.md

@@ -0,0 +1,176 @@
+# Client-side hooks
+Most of these hooks are called during or in order to set up the formatting process.
+
+## documentReady
+Called from: src/templates/pad.html
+
+Things in context:
+
+nothing
+
+This hook proxies the functionality of jQuery's `$(document).ready` event.
+
+## aceDomLineProcessLineAttributes
+Called from: src/static/js/domline.js
+
+Things in context:
+
+1. domline - The current DOM line being processed
+2. cls - The class of the current block element (useful for styling)
+
+This hook is called for elements in the DOM that have the "lineMarkerAttribute" set. You can add elements into this category with the aceRegisterBlockElements hook above.
+
+The return value of this hook should have the following structure:
+
+`{ preHtml: String, postHtml: String, processedMarker: Boolean }`
+
+The preHtml and postHtml values will be added to the HTML display of the element, and if processedMarker is true, the engine won't try to process it any more.
+
+## aceCreateDomLine
+Called from: src/static/js/domline.js
+
+Things in context:
+
+1. domline - the current DOM line being processed
+2. cls - The class of the current element (useful for styling)
+
+This hook is called for any line being processed by the formatting engine, unless the aceDomLineProcessLineAttributes hook from above returned true, in which case this hook is skipped.
+
+The return value of this hook should have the following structure:
+
+`{ extraOpenTags: String, extraCloseTags: String, cls: String }`
+
+extraOpenTags and extraCloseTags will be added before and after the element in question, and cls will be the new class of the element going forward.
+
+## acePostWriteDomLineHTML
+Called from: src/static/js/domline.js
+
+Things in context:
+
+1. node - the DOM node that just got written to the page
+
+This hook is for right after a node has been fully formatted and written to the page.
+
+## aceAttribsToClasses
+Called from: src/static/js/linestylefilter.js
+
+Things in context:
+
+1. linestylefilter - the JavaScript object that's currently processing the ace attributes
+2. key - the current attribute being processed
+3. value - the value of the attribute being processed
+
+This hook is called during the attribute processing procedure, and should be used to translate key, value pairs into valid HTML classes that can be inserted into the DOM.
+
+The return value for this function should be a list of classes, which will then be parsed into a valid class string.
+
+## aceGetFilterStack
+Called from: src/static/js/linestylefilter.js
+
+Things in context:
+
+1. linestylefilter - the JavaScript object that's currently processing the ace attributes
+2. browser - an object indicating which browser is accessing the page
+
+This hook is called to apply custom regular expression filters to a set of styles. The one example available is the ep_linkify plugin, which adds internal links. They use it to find the telltale `[[ ]]` syntax that signifies internal links, and finding that syntax, they add in the internalHref attribute to be later used by the aceCreateDomLine hook (documented above).
+
+## aceEditorCSS
+Called from: src/static/js/ace.js
+
+Things in context: None
+
+This hook is provided to allow custom CSS files to be loaded. The return value should be an array of paths relative to the plugins directory.
+
+## aceInitInnerdocbodyHead
+Called from: src/static/js/ace.js
+
+Things in context:
+
+1. iframeHTML - the HTML of the editor iframe up to this point, in array format
+
+This hook is called during the creation of the editor HTML. The array should have lines of HTML added to it, giving the plugin author a chance to add in meta, script, link, and other tags that go into the `<head>` element of the editor HTML document.
+
+## aceEditEvent
+Called from: src/static/js/ace2_inner.js
+
+Things in context:
+
+1. callstack - a bunch of information about the current action
+2. editorInfo - information about the user who is making the change
+3. rep - information about where the change is being made
+4. documentAttributeManager - information about attributes in the document (this is a mystery to me)
+
+This hook is made available to edit the edit events that might occur when changes are made. Currently you can change the editor information, some of the meanings of the edit, and so on. You can also make internal changes (internal to your plugin) that use the information provided by the edit event.
+
+## aceRegisterBlockElements
+Called from: src/static/js/ace2_inner.js
+
+Things in context: None
+
+The return value of this hook will add elements into the "lineMarkerAttribute" category, making the aceDomLineProcessLineAttributes hook (documented below) call for those elements.
+
+## aceInitialized
+Called from: src/static/js/ace2_inner.js
+
+Things in context:
+
+1. editorInfo - information about the user who will be making changes through the interface, and a way to insert functions into the main ace object (see ep_headings)
+2. rep - information about where the user's cursor is
+3. documentAttributeManager - some kind of magic
+
+This hook is for inserting further information into the ace engine, for later use in formatting hooks.
+
+## postAceInit
+Called from: src/static/js/pad.js
+
+Things in context:
+
+1. ace - the ace object that is applied to this editor.
+
+There doesn't appear to be any example available of this particular hook being used, but it gets fired after the editor is all set up.
+
+## userJoinOrUpdate
+Called from: src/static/js/pad_userlist.js
+
+Things in context:
+
+1. info - the user information
+
+This hook is called on the client side whenever a user joins or changes. This can be used to create notifications or an alternate user list.
+
+## collectContentPre
+Called from: src/static/js/contentcollector.js
+
+Things in context:
+
+1. cc - the contentcollector object
+2. state - the current state of the change being made
+3. tname - the tag name of this node currently being processed
+4. style - the style applied to the node (probably CSS)
+5. cls - the HTML class string of the node
+
+This hook is called before the content of a node is collected by the usual methods. The cc object can be used to do a bunch of things that modify the content of the pad. See, for example, the heading1 plugin for etherpad original.
+
+## collectContentPost
+Called from: src/static/js/contentcollector.js
+
+Things in context:
+
+1. cc - the contentcollector object
+2. state - the current state of the change being made
+3. tname - the tag name of this node currently being processed
+4. style - the style applied to the node (probably CSS)
+5. cls - the HTML class string of the node
+
+This hook is called after the content of a node is collected by the usual methods. The cc object can be used to do a bunch of things that modify the content of the pad. See, for example, the heading1 plugin for etherpad original.
+
+## handleClientMessage_`name`
+Called from: `src/static/js/collab_client.js`
+
+Things in context:
+
+1. payload - the data that got sent with the message (use it for custom message content)
+
+This hook gets called every time the client receives a message of type `name`. This can most notably be used with the new HTTP API call, "sendClientsMessage", which sends a custom message type to all clients connected to a pad. You can also use this to handle existing types.
+
+`collab_client.js` has a pretty extensive list of message types, if you want to take a look.

doc/api/hooks_overview.adoc

@@ -1,116 +0,0 @@
-== Hooks
-
-A hook function is registered with a hook via the plugin's `ep.json` file. See
-the Plugins section for details. A hook may have many registered functions from
-different plugins.
-
-Some hooks call their registered functions one at a time until one of them
-returns a value. Others always call all of their registered functions and
-combine the results (if applicable).
-
-=== Registered hook functions
-
-Note: The documentation in this section applies to every hook unless the
-hook-specific documentation says otherwise.
-
-==== Arguments
-
-Hook functions are called with three arguments:
-
-1. `hookName` - The name of the hook being invoked.
-2. `context` - An object with some relevant information about the context of the
-   call. See the hook-specific documentation for details.
-3. `cb` - For asynchronous operations this callback can be called to signal
-   completion and optionally provide a return value. The callback takes a single
-   argument, the meaning of which depends on the hook (see the "Return values"
-   section for general information that applies to most hooks). This callback
-   always returns `undefined`.
-
-==== Expected behavior
-
-The presence of a callback parameter suggests that every hook function can run
-asynchronously. While that is the eventual goal, there are some legacy hooks
-that expect their hook functions to provide a value synchronously. For such
-hooks, the hook functions must do one of the following:
-
-* Call the callback with a non-Promise value (`undefined` is acceptable) and
-  return `undefined`, in that order.
-* Return a non-Promise value other than `undefined` (`null` is acceptable) and
-  never call the callback. Note that `async` functions *always* return a
-  Promise, so they must never be used for synchronous hooks.
-* Only have two parameters (`hookName` and `context`) and return any non-Promise
-  value (`undefined` is acceptable).
-
-For hooks that permit asynchronous behavior, the hook functions must do one or
-more of the following:
-
-* Return `undefined` and call the callback, in either order.
-* Return something other than `undefined` (`null` is acceptable) and never call
-  the callback. Note that `async` functions *always* return a Promise, so they
-  must never call the callback.
-* Only have two parameters (`hookName` and `context`).
-
-Note that the acceptable behaviors for asynchronous hook functions is a superset
-of the acceptable behaviors for synchronous hook functions.
-
-WARNING: The number of parameters is determined by examining
-https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/length[Function.length],
-which does not count https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Default_parameters[default parameters]
-or https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/rest_parameters["rest" parameters].
-To avoid problems, do not use default or rest parameters when defining hook
-functions.
-
-==== Return values
-
-A hook function can provide a value to Etherpad in one of the following ways:
-
-* Pass the desired value as the first argument to the callback.
-* Return the desired value directly. The value must not be `undefined` unless
-  the hook function only has two parameters. (Hook functions with three
-  parameters that want to provide `undefined` should instead use the callback.)
-* For hooks that permit asynchronous behavior, return a Promise that resolves to
-  the desired value.
-* For hooks that permit asynchronous behavior, pass a Promise that resolves to
-  the desired value as the first argument to the callback.
-
-Examples:
-
-[source,javascript]
-----
-exports.exampleOne = (hookName, context, callback) => {
-  return 'valueOne';
-};
-
-exports.exampleTwo = (hookName, context, callback) => {
-  callback('valueTwo');
-  return;
-};
-
-// ONLY FOR HOOKS THAT PERMIT ASYNCHRONOUS BEHAVIOR
-exports.exampleThree = (hookName, context, callback) => {
-  return new Promise('valueThree');
-};
-
-// ONLY FOR HOOKS THAT PERMIT ASYNCHRONOUS BEHAVIOR
-exports.exampleFour = (hookName, context, callback) => {
-  callback(new Promise('valueFour'));
-  return;
-};
-
-// ONLY FOR HOOKS THAT PERMIT ASYNCHRONOUS BEHAVIOR
-exports.exampleFive = async (hookName, context) => {
-  // Note that this function is async, so it actually returns a Promise that
-  // is resolved to 'valueFive'.
-  return 'valueFive';
-};
-----
-
-Etherpad collects the values provided by the hook functions into an array,
-filters out all `undefined` values, then flattens the array one level.
-Flattening one level makes it possible for a hook function to behave as if it
-were multiple separate hook functions.
-
-For example: Suppose a hook has eight registered functions that return the
-following values: `1`, `[2]`, `['3a', '3b']` `[[4]]`, `undefined`,
-`[undefined]`, `[]`, and `null`. The value returned to the caller of the hook is
-`[1, 2, '3a', '3b', [4], undefined, null]`.

doc/api/hooks_server-side.md

@@ -0,0 +1,138 @@
+# Server-side hooks
+These hooks are called on server-side.
+
+## loadSettings
+Called from: src/node/server.js
+
+Things in context:
+
+1. settings - the settings object
+
+Use this hook to receive the global settings in your plugin.
+
+## pluginUninstall
+Called from: src/static/js/pluginfw/installer.js
+
+Things in context:
+
+1. plugin_name - self-explanatory
+
+If this hook returns an error, the callback to the uninstall function gets an error as well. This mostly seems useful for handling additional features added in based on the installation of other plugins, which is pretty cool!
+
+## pluginInstall
+Called from: src/static/js/pluginfw/installer.js
+
+Things in context:
+
+1. plugin_name - self-explanatory
+
+If this hook returns an error, the callback to the install function gets an error, too. This seems useful for adding in features when a particular plugin is installed.
+
+## init_`<plugin name>`
+Called from: src/static/js/pluginfw/plugins.js
+
+Things in context: None
+
+This function is called after a specific plugin is initialized. This would probably be more useful than the previous two functions if you only wanted to add in features to one specific plugin.
+
+## expressConfigure
+Called from: src/node/server.js
+
+Things in context:
+
+1. app - the main application object
+
+This is a helpful hook for changing the behavior and configuration of the application. It's called right after the application gets configured.
+
+## expressCreateServer
+Called from: src/node/server.js
+
+Things in context:
+
+1. app - the main application object (helpful for adding new paths and such)
+
+This hook gets called after the application object has been created, but before it starts listening. This is similar to the expressConfigure hook, but it's not guaranteed that the application object will have all relevant configuration variables.
+
+## eejsBlock_`<name>`
+Called from: src/node/eejs/index.js
+
+Things in context:
+
+1. content - the content of the block
+
+This hook gets called upon the rendering of an ejs template block. For any specific kind of block, you can change how that block gets rendered by modifying the content object passed in.
+
+Have a look at `src/templates/pad.html` and `src/templates/timeslider.html` to see which blocks are available.
+
+## socketio
+Called from: src/node/hooks/express/socketio.js
+
+Things in context:
+
+1. app - the application object
+2. io - the socketio object
+
+I have no idea what this is useful for, someone else will have to add this description.
+
+## authorize
+Called from: src/node/hooks/express/webaccess.js
+
+Things in context:
+
+1. req - the request object
+2. res - the response object
+3. next - ?
+4. resource - the path being accessed
+
+This is useful for modifying the way authentication is done, especially for specific paths.
+
+## authenticate
+Called from: src/node/hooks/express/webaccess.js
+
+Things in context:
+
+1. req - the request object
+2. res - the response object
+3. next - ?
+4. username - the username used (optional)
+5. password - the password used (optional)
+
+This is useful for modifying the way authentication is done.
+
+## authFailure
+Called from: src/node/hooks/express/webaccess.js
+
+Things in context:
+
+1. req - the request object
+2. res - the response object
+3. next - ?
+
+This is useful for modifying the way authentication is done.
+
+## handleMessage
+Called from: src/node/handler/PadMessageHandler.js
+
+Things in context:
+
+1. message - the message being handled
+2. client - the client object from socket.io
+
+This hook will be called once a message arrive. If a plugin calls `callback(null)` the message will be dropped. However it is not possible to modify the message.
+
+Plugins may also decide to implement custom behavior once a message arrives.
+
+**WARNING**: handleMessage will be called, even if the client is not authorized to send this message. It's up to the plugin to check permissions.
+
+Example:
+
+```
+function handleMessage ( hook, context, callback ) {
+  if ( context.message.type == 'USERINFO_UPDATE' ) {
+    // If the message type is USERINFO_UPDATE, drop the message
+    callback(null);
+  }else{
+    callback();
+  }
+};
+```

doc/api/http_api.adoc

@@ -1,693 +0,0 @@
-== HTTP API
-
-=== What can I do with this API?
-The API gives another web application control of the pads. The basic functions are
-
-* create/delete pads
-* grant/forbid access to pads
-* get/set pad content
-
-The API is designed in a way, so you can reuse your existing user system with their permissions, and map it to Etherpad. Means: Your web application still has to do authentication, but you can tell Etherpad via the api, which visitors should get which permissions. This allows Etherpad to fit into any web application and extend it with real-time functionality. You can embed the pads via an iframe into your website.
-
-Take a look at https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries[HTTP API client libraries] to check if a library in your favorite programming language is available.
-
-==== OpenAPI
-
-OpenAPI (formerly swagger) definitions are exposed under `/api/openapi.json` (latest) and `/api/{version}/openapi.json`. You can use official tools like https://editor.swagger.io/[Swagger Editor] to view and explore them.
-
-=== Examples
-
-==== Example 1
-
-A portal (such as WordPress) wants to give a user access to a new pad. Let's assume the user have the internal id 7 and his name is michael.
-
-Portal maps the internal userid to an etherpad author.
-
-> Request: `http://pad.domain/api/1/createAuthorIfNotExistsFor?apikey=secret&name=Michael&authorMapper=7`
->
-> Response: `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
-
-Portal maps the internal userid to an etherpad group:
-
-> Request: `http://pad.domain/api/1/createGroupIfNotExistsFor?apikey=secret&groupMapper=7`
->
-> Response: `{code: 0, message:"ok", data: {groupID: "g.s8oes9dhwrvt0zif"}}`
-
-Portal creates a pad in the userGroup
-
-> Request: `http://pad.domain/api/1/createGroupPad?apikey=secret&groupID=g.s8oes9dhwrvt0zif&padName=samplePad&text=This is the first sentence in the pad`
->
-> Response: `{code: 0, message:"ok", data: null}`
-
-Portal starts the session for the user on the group:
-
-> Request: `http://pad.domain/api/1/createSession?apikey=secret&groupID=g.s8oes9dhwrvt0zif&authorID=a.s8oes9dhwrvt0zif&validUntil=1312201246`
->
-> Response: `{"data":{"sessionID": "s.s8oes9dhwrvt0zif"}}`
-
-Portal places the cookie "sessionID" with the given value on the client and creates an iframe including the pad.
-
-==== Example 2
-
-A portal (such as WordPress) wants to transform the contents of a pad that multiple admins edited into a blog post.
-
-Portal retrieves the contents of the pad for entry into the db as a blog post:
-
-> Request: `http://pad.domain/api/1/getText?apikey=secret&padID=g.s8oes9dhwrvt0zif$123`
->
-> Response: `{code: 0, message:"ok", data: {text:"Welcome Text"}}`
-
-Portal submits content into new blog post
-
-> Portal.AddNewBlog(content)
->
-
-=== Usage
-
-==== API version
-The latest version is `1.2.15`
-
-The current version can be queried via /api.
-
-==== Request Format
-
-The API is accessible via HTTP. Starting from **1.8**, API endpoints can be invoked indifferently via GET or POST.
-
-The URL of the HTTP request is of the form: `/api/$APIVERSION/$FUNCTIONNAME`. $APIVERSION depends on the endpoint you want to use. Depending on the verb you use (GET or POST) **parameters** can be passed differently.
-
-When invoking via GET (mandatory until **1.7.5** included), parameters must be included in the query string (example: `/api/$APIVERSION/$FUNCTIONNAME?apikey=<APIKEY>&param1=value1`). Please note that starting with nodejs 8.14+ the total size of HTTP request headers has been capped to 8192 bytes. This limits the quantity of data that can be sent in an API request.
-
-Starting from Etherpad **1.8** it is also possible to invoke the HTTP API via POST. In this case, querystring parameters will still be accepted, but **any parameter with the same name sent via POST will take precedence**. If you need to send large chunks of text (for example, for `setText()`) it is advisable to invoke via POST.
-
-Example with cURL using GET (toy example, no encoding):
-
-[source,bash]
-----
-curl "http://pad.domain/api/1/setText?apikey=secret&padID=padname&text=this_text_will_NOT_be_encoded_by_curl_use_next_example"
-----
-
-Example with cURL using GET (better example, encodes text):
-
-[source,bash]
-----
-curl "http://pad.domain/api/1/setText?apikey=secret&padID=padname" --get --data-urlencode "text=Text sent via GET with proper encoding. For big documents, please use POST"
-----
-
-Example with cURL using POST:
-
-[source,bash]
-----
-curl "http://pad.domain/api/1/setText?apikey=secret&padID=padname" --data-urlencode "text=Text sent via POST with proper encoding. For big texts (>8 KB), use this method"
-----
-
-==== Response Format
-Responses are valid JSON in the following format:
-
-[source,jsonlines]
-----
-{
-  "code": number,
-  "message": string,
-  "data": obj
-}
-----
-
-* **code** a return code
-  * **0** everything ok
-  * **1** wrong parameters
-  * **2** internal error
-  * **3** no such function
-  * **4** no or wrong API Key
-* **message** a status message. It's ok if everything is fine, else it contains an error message
-* **data** the payload
-
-==== Overview
-
-image::https://i.imgur.com/d0nWp.png[API Overview]
-
-=== Data Types
-
-* **groupID**  a string, the unique id of a group. Format is g.16RANDOMCHARS, for example g.s8oes9dhwrvt0zif
-* **sessionID** a string, the unique id of a session. Format is s.16RANDOMCHARS, for example s.s8oes9dhwrvt0zif
-* **authorID** a string, the unique id of an author. Format is a.16RANDOMCHARS, for example a.s8oes9dhwrvt0zif
-* **readOnlyID** a string, the unique id of a readonly relation to a pad. Format is r.16RANDOMCHARS, for example r.s8oes9dhwrvt0zif
-* **padID** a string, format is GROUPID$PADNAME, for example the pad test of group g.s8oes9dhwrvt0zif has padID g.s8oes9dhwrvt0zif$test
-
-==== Authentication
-
-Authentication works via a token that is sent with each request as a post parameter.  There is a single token per Etherpad deployment.  This token will be random string, generated by Etherpad at the first start. It will be saved in APIKEY.txt in the root folder of Etherpad. Only Etherpad and the requesting application knows this key. Token management will not be exposed through this API.
-
-==== Node Interoperability
-
-All functions will also be available through a node module accessible from other node.js applications.
-
-=== API Methods
-
-==== Groups
-Pads can belong to a group. The padID of grouppads is starting with a groupID like g.asdfasdfasdfasdf$test
-
-===== createGroup()
- * API >= 1
-
-creates a new group
-
-_Example returns:_
-
-* `{code: 0, message:"ok", data: {groupID: g.s8oes9dhwrvt0zif}}`
-
-===== createGroupIfNotExistsFor(groupMapper)
- * API >= 1
-
-this functions helps you to map your application group ids to Etherpad group ids
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {groupID: g.s8oes9dhwrvt0zif}}`
-
-===== deleteGroup(groupID)
- * API >= 1
-
-deletes a group
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"groupID does not exist", data: null}`
-
-===== listPads(groupID)
- * API >= 1
-
-returns all pads of this group
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {padIDs : ["g.s8oes9dhwrvt0zif$test", "g.s8oes9dhwrvt0zif$test2"]}`
-  * `{code: 1, message:"groupID does not exist", data: null}`
-
-===== createGroupPad(groupID, padName, [text], [authorId])
- * API >= 1
- * `authorId` in API >= 1.3.0
-
-creates a new pad in this group
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {padID: "g.s8oes9dhwrvt0zif$test"}`
-  * `{code: 1, message:"padName does already exist", data: null}`
-  * `{code: 1, message:"groupID does not exist", data: null}`
-
-===== listAllGroups()
- * API >= 1.1
-
-lists all existing groups
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {groupIDs: ["g.mKjkmnAbSMtCt8eL", "g.3ADWx6sbGuAiUmCy"]}}`
-  * `{code: 0, message:"ok", data: {groupIDs: []}}`
-
-==== Author
-These authors are bound to the attributes the users choose (color and name).
-
-===== createAuthor([name])
- * API >= 1
-
-creates a new author
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
-
-===== createAuthorIfNotExistsFor(authorMapper [, name])
- * API >= 1
-
-this functions helps you to map your application author ids to Etherpad author ids
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
-
-===== listPadsOfAuthor(authorID)
- * API >= 1
-
-returns an array of all pads this author contributed to
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {padIDs: ["g.s8oes9dhwrvt0zif$test", "g.s8oejklhwrvt0zif$foo"]}}`
-  * `{code: 1, message:"authorID does not exist", data: null}`
-
-===== getAuthorName(authorID)
- * API >= 1.1
-
-Returns the Author Name of the author
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {authorName: "John McLear"}}`
-
--> can't be deleted cause this would involve scanning all the pads where this author was
-
-==== Session
-Sessions can be created between a group and an author. This allows an author to access more than one group. The sessionID will be set as a cookie to the client and is valid until a certain date. The session cookie can also contain multiple comma-separated sessionIDs, allowing a user to edit pads in different groups at the same time. Only users with a valid session for this group, can access group pads. You can create a session after you authenticated the user at your web application, to give them access to the pads. You should save the sessionID of this session and delete it after the user logged out.
-
-===== createSession(groupID, authorID, validUntil)
- * API >= 1
-
-creates a new session. validUntil is an unix timestamp in seconds
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {sessionID: "s.s8oes9dhwrvt0zif"}}`
-  * `{code: 1, message:"groupID doesn't exist", data: null}`
-  * `{code: 1, message:"authorID doesn't exist", data: null}`
-  * `{code: 1, message:"validUntil is in the past", data: null}`
-
-===== deleteSession(sessionID)
- * API >= 1
-
-deletes a session
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"sessionID does not exist", data: null}`
-
-===== getSessionInfo(sessionID)
- * API >= 1
-
-returns information about a session
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif", groupID: g.s8oes9dhwrvt0zif, validUntil: 1312201246}}`
-  * `{code: 1, message:"sessionID does not exist", data: null}`
-
-===== listSessionsOfGroup(groupID)
- * API >= 1
-
-returns all sessions of a group
-
-_Example returns:_
-
-  * `{"code":0,"message":"ok","data":{"s.oxf2ras6lvhv2132":{"groupID":"g.s8oes9dhwrvt0zif","authorID":"a.akf8finncvomlqva","validUntil":2312905480}}}`
-  * `{code: 1, message:"groupID does not exist", data: null}`
-
-===== listSessionsOfAuthor(authorID)
- * API >= 1
-
-returns all sessions of an author
-
-_Example returns:_
-
-  * `{"code":0,"message":"ok","data":{"s.oxf2ras6lvhv2132":{"groupID":"g.s8oes9dhwrvt0zif","authorID":"a.akf8finncvomlqva","validUntil":2312905480}}}`
-  * `{code: 1, message:"authorID does not exist", data: null}`
-
-==== Pad Content
-
-Pad content can be updated and retrieved through the API
-
-===== getText(padID, [rev])
- * API >= 1
-
-returns the text of a pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {text:"Welcome Text"}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-===== setText(padID, text, [authorId])
- * API >= 1
- * `authorId` in API >= 1.3.0
-
-Sets the text of a pad.
-
-If your text is long (>8 KB), please invoke via POST and include `text` parameter in the body of the request, not in the URL (since Etherpad **1.8**).
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-  * `{code: 1, message:"text too long", data: null}`
-
-===== appendText(padID, text, [authorId])
- * API >= 1.2.13
- * `authorId` in API >= 1.3.0
-
-Appends text to a pad.
-
-If your text is long (>8 KB), please invoke via POST and include `text` parameter in the body of the request, not in the URL (since Etherpad **1.8**).
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-  * `{code: 1, message:"text too long", data: null}`
-
-===== getHTML(padID, [rev])
- * API >= 1
-
-returns the text of a pad formatted as HTML
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {html:"Welcome Text<br>More Text"}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-===== setHTML(padID, html, [authorId])
- * API >= 1
- * `authorId` in API >= 1.3.0
-
-sets the text of a pad based on HTML, HTML must be well-formed. Malformed HTML will send a warning to the API log.
-
-If `html` is long (>8 KB), please invoke via POST and include `html` parameter in the body of the request, not in the URL (since Etherpad **1.8**).
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-===== getAttributePool(padID)
- * API >= 1.2.8
-
-returns the attribute pool of a pad
-
-_Example returns:_
-
-  * `{ "code":0,
-       "message":"ok",
-       "data": {
-         "pool":{
-           "numToAttrib":{
-             "0":["author","a.X4m8bBWJBZJnWGSh"],
-             "1":["author","a.TotfBPzov54ihMdH"],
-             "2":["author","a.StiblqrzgeNTbK05"],
-             "3":["bold","true"]
-           },
-           "attribToNum":{
-             "author,a.X4m8bBWJBZJnWGSh":0,
-             "author,a.TotfBPzov54ihMdH":1,
-             "author,a.StiblqrzgeNTbK05":2,
-             "bold,true":3
-           },
-           "nextNum":4
-         }
-       }
-     }`
-  * `{"code":1,"message":"padID does not exist","data":null}`
-
-===== getRevisionChangeset(padID, [rev])
- * API >= 1.2.8
-
-get the changeset at a given revision, or last revision if 'rev' is not defined.
-
-_Example returns:_
-
-  * `{ "code" : 0,
-       "message" : "ok",
-       "data" : "Z:1>6b|5+6b$Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at https://etherpad.org\n"
-     }`
-  * `{"code":1,"message":"padID does not exist","data":null}`
-  * `{"code":1,"message":"rev is higher than the head revision of the pad","data":null}`
-
-===== createDiffHTML(padID, startRev, endRev)
- * API >= 1.2.7
-
-returns an object of diffs from 2 points in a pad
-
-_Example returns:_
-
-  * `{"code":0,"message":"ok","data":{"html":"<style>\n.authora_HKIv23mEbachFYfH {background-color: #a979d9}\n.authora_n4gEeMLsv1GivNeh {background-color: #a9b5d9}\n.removed {text-decoration: line-through; -ms-filter:'progid:DXImageTransform.Microsoft.Alpha(Opacity=80)'; filter: alpha(opacity=80); opacity: 0.8; }\n</style>Welcome to Etherpad!<br><br>This pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!<br><br>Get involved with Etherpad at <a href=\"http&#x3a;&#x2F;&#x2F;etherpad&#x2e;org\">http:&#x2F;&#x2F;etherpad.org</a><br><span class=\"authora_HKIv23mEbachFYfH\">aw</span><br><br>","authors":["a.HKIv23mEbachFYfH",""]}}`
-  * `{"code":4,"message":"no or wrong API Key","data":null}`
-
-===== restoreRevision(padId, rev, [authorId])
- * API >= 1.2.11
- * `authorId` in API >= 1.3.0
-
-Restores revision from past as new changeset
-
-_Example returns:_
-
-  * {code:0, message:"ok", data:null}
-  * {code: 1, message:"padID does not exist", data: null}
-
-==== Chat
-
-===== getChatHistory(padID, [start, end])
- * API >= 1.2.7
-
-returns
-
-* a part of the chat history, when `start` and `end` are given
-* the whole chat history, when no extra parameters are given
-
-
-_Example returns:_
-
-* `{"code":0,"message":"ok","data":{"messages":[{"text":"foo","userId":"a.foo","time":1359199533759,"userName":"test"},{"text":"bar","userId":"a.foo","time":1359199534622,"userName":"test"}]}}`
-* `{code: 1, message:"start is higher or equal to the current chatHead", data: null}`
-* `{code: 1, message:"padID does not exist", data: null}`
-
-===== getChatHead(padID)
- * API >= 1.2.7
-
-returns the chatHead (last number of the last chat-message) of the pad
-
-
-_Example returns:_
-
-* `{code: 0, message:"ok", data: {chatHead: 42}}`
-* `{code: 1, message:"padID does not exist", data: null}`
-
-===== appendChatMessage(padID, text, authorID [, time])
- * API >= 1.2.12
-
-creates a chat message, saves it to the database and sends it to all connected clients of this pad
-
-
-_Example returns:_
-
-* `{code: 0, message:"ok", data: null}`
-* `{code: 1, message:"text is no string", data: null}`
-
-=== Pad
-Group pads are normal pads, but with the name schema GROUPID$PADNAME. A security manager controls access of them and it's forbidden for normal pads to include a $ in the name.
-
-==== createPad(padID, [text], [authorId])
- * API >= 1
- * `authorId` in API >= 1.3.0
-
-creates a new (non-group) pad.  Note that if you need to create a group Pad, you should call **createGroupPad**.
-You get an error message if you use one of the following characters in the padID: "/", "?", "&" or "#".
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does already exist", data: null}`
-  * `{code: 1, message:"malformed padID: Remove special characters", data: null}`
-
-==== getRevisionsCount(padID)
- * API >= 1
-
-returns the number of revisions of this pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {revisions: 56}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== getSavedRevisionsCount(padID)
- * API >= 1.2.11
-
-returns the number of saved revisions of this pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {savedRevisions: 42}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== listSavedRevisions(padID)
- * API >= 1.2.11
-
-returns the list of saved revisions of this pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {savedRevisions: [2, 42, 1337]}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== saveRevision(padID [, rev])
- * API >= 1.2.11
-
-saves a revision
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== padUsersCount(padID)
- * API >= 1
-
-returns the number of user that are currently editing this pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {padUsersCount: 5}}`
-
-==== padUsers(padID)
- * API >= 1.1
-
-returns the list of users that are currently editing this pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {padUsers: [{colorId:"#c1a9d9","name":"username1","timestamp":1345228793126,"id":"a.n4gEeMLsvg12452n"},{"colorId":"#d9a9cd","name":"Hmmm","timestamp":1345228796042,"id":"a.n4gEeMLsvg12452n"}]}}`
-  * `{code: 0, message:"ok", data: {padUsers: []}}`
-
-==== deletePad(padID)
- * API >= 1
-
-deletes a pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== copyPad(sourceID, destinationID[, force=false])
- * API >= 1.2.8
-
-copies a pad with full history and chat. If force is true and the destination pad exists, it will be overwritten.
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== copyPadWithoutHistory(sourceID, destinationID, [force=false], [authorId])
-* API >= 1.2.15
- * `authorId` in API >= 1.3.0
-
-copies a pad without copying the history and chat. If force is true and the destination pad exists, it will be overwritten.
-Note that all the revisions will be lost! In most of the cases one should use `copyPad` API instead.
-
-_Example returns:_
-
-* `{code: 0, message:"ok", data: null}`
-* `{code: 1, message:"padID does not exist", data: null}`
-
-==== movePad(sourceID, destinationID[, force=false])
- * API >= 1.2.8
-
-moves a pad. If force is true and the destination pad exists, it will be overwritten.
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== getReadOnlyID(padID)
- * API >= 1
-
-returns the read only link of a pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {readOnlyID: "r.s8oes9dhwrvt0zif"}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== getPadID(readOnlyID)
- * API >= 1.2.10
-
-returns the id of a pad which is assigned to the readOnlyID
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {padID: "p.s8oes9dhwrvt0zif"}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== setPublicStatus(padID, publicStatus)
- * API >= 1
-
-sets a boolean for the public status of a group pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: null}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-  * `{code: 1, message:"You can only get/set the publicStatus of pads that belong to a group", data: null}`
-
-==== getPublicStatus(padID)
- * API >= 1
-
-return true of false
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {publicStatus: true}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-  * `{code: 1, message:"You can only get/set the publicStatus of pads that belong to a group", data: null}`
-
-==== listAuthorsOfPad(padID)
- * API >= 1
-
-returns an array of authors who contributed to this pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {authorIDs : ["a.s8oes9dhwrvt0zif", "a.akf8finncvomlqva"]}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== getLastEdited(padID)
- * API >= 1
-
-returns the timestamp of the last revision of the pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {lastEdited: 1340815946602}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== sendClientsMessage(padID, msg)
- * API >= 1.1
-
-sends a custom message of type `msg` to the pad
-
-_Example returns:_
-
-  * `{code: 0, message:"ok", data: {}}`
-  * `{code: 1, message:"padID does not exist", data: null}`
-
-==== checkToken()
- * API >= 1.2
-
-returns ok when the current api token is valid
-
-_Example returns:_
-
-  * `{"code":0,"message":"ok","data":null}`
-  * `{"code":4,"message":"no or wrong API Key","data":null}`
-
-=== Pads
-
-==== listAllPads()
- * API >= 1.2.1
-
-lists all pads on this epl instance
-
-_Example returns:_
-
- * `{code: 0, message:"ok", data: {padIDs: ["testPad", "thePadsOfTheOthers"]}}`
-
-==== Global
-
-===== getStats()
- *  API >= 1.2.14
-
-get stats of the etherpad instance
-
-_Example returns_:
-
- * `{"code":0,"message":"ok","data":{"totalPads":3,"totalSessions": 2,"totalActivePads": 1}}`

doc/api/http_api.md

@@ -0,0 +1,254 @@
+# HTTP API
+
+## What can I do with this API?
+The API gives another web application control of the pads. The basic functions are
+
+* create/delete pads 
+* grant/forbid access to pads
+* get/set pad content
+
+The API is designed in a way, so you can reuse your existing user system with their permissions, and map it to etherpad lite. Means: Your web application still has to do authentication, but you can tell etherpad lite via the api, which visitors should get which permissions. This allows etherpad lite to fit into any web application and extend it with real-time functionality. You can embed the pads via an iframe into your website.
+
+Take a look at [HTTP API client libraries](https://github.com/Pita/etherpad-lite/wiki/HTTP-API-client-libraries) to see if a library in your favorite language.
+
+## Examples
+
+### Example 1
+
+A portal (such as WordPress) wants to give a user access to a new pad. Let's assume the user have the internal id 7 and his name is michael. 
+
+Portal maps the internal userid to an etherpad author. 
+
+> Request: `http://pad.domain/api/1/createAuthorIfNotExistsFor?apikey=secret&name=Michael&authorMapper=7`
+> 
+> Response: `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
+
+Portal maps the internal userid to an etherpad group:
+
+> Request: `http://pad.domain/api/1/createGroupIfNotExistsFor?apikey=secret&groupMapper=7`
+> 
+> Response: `{code: 0, message:"ok", data: {groupID: "g.s8oes9dhwrvt0zif"}}`
+
+Portal creates a pad in the userGroup
+
+> Request: `http://pad.domain/api/1/createGroupPad?apikey=secret&groupID=g.s8oes9dhwrvt0zif&padName=samplePad&text=This is the first sentence in the pad`
+> 
+> Response: `{code: 0, message:"ok", data: null}`
+
+Portal starts the session for the user on the group:
+
+> Request: `http://pad.domain/api/1/createSession?apikey=secret&groupID=g.s8oes9dhwrvt0zif&authorID=a.s8oes9dhwrvt0zif&validUntil=1312201246`
+> 
+> Response: `{"data":{"sessionID": "s.s8oes9dhwrvt0zif"}}`
+
+Portal places the cookie "sessionID" with the given value on the client and creates an iframe including the pad.
+
+### Example 2
+
+A portal (such as WordPress) wants to transform the contents of a pad that multiple admins edited into a blog post.
+
+Portal retrieves the contents of the pad for entry into the db as a blog post:
+
+> Request: `http://pad.domain/api/1/getText?apikey=secret&padID=g.s8oes9dhwrvt0zif$123`
+> 
+> Response: `{code: 0, message:"ok", data: {text:"Welcome Text"}}`
+
+Portal submits content into new blog post
+
+> Portal.AddNewBlog(content)
+>
+
+## Usage
+
+### Request Format
+
+The API is accessible via HTTP. HTTP Requests are in the format /api/$APIVERSION/$FUNCTIONNAME. Parameters are transmitted via HTTP GET. $APIVERSION is 1
+
+### Response Format
+Responses are valid JSON in the following format:
+
+```js
+{
+  "code": number,
+  "message": string,
+  "data": obj
+}
+```
+
+* **code** a return code
+  * **0** everything ok
+  * **1** wrong parameters
+  * **2** internal error
+  * **3** no such function
+  * **4** no or wrong API Key
+* **message** a status message. Its ok if everything is fine, else it contains an error message
+* **data** the payload
+
+### Overview
+
+![API Overview](http://i.imgur.com/d0nWp.png)
+
+## Data Types
+
+* **groupID**  a string, the unique id of a group. Format is g.16RANDOMCHARS, for example g.s8oes9dhwrvt0zif
+* **sessionID** a string, the unique id of a session. Format is s.16RANDOMCHARS, for example s.s8oes9dhwrvt0zif
+* **authorID** a string, the unique id of an author. Format is a.16RANDOMCHARS, for example a.s8oes9dhwrvt0zif
+* **readOnlyID** a string, the unique id of an readonly relation to a pad. Format is r.16RANDOMCHARS, for example r.s8oes9dhwrvt0zif
+* **padID** a string, format is GROUPID$PADNAME, for example the pad test of group g.s8oes9dhwrvt0zif has padID g.s8oes9dhwrvt0zif$test
+
+### Authentication
+
+Authentication works via a token that is sent with each request as a post parameter.  There is a single token per Etherpad-Lite deployment.  This token will be random string, generated by Etherpad-Lite at the first start. It will be saved in APIKEY.txt in the root folder of Etherpad Lite. Only Etherpad Lite and the requesting application knows this key. Token management will not be exposed through this API. 
+
+### Node Interoperability
+
+All functions will also be available through a node module accessable from other node.js applications.
+
+### JSONP
+
+The API provides _JSONP_ support to allow requests from a server in a different domain.
+Simply add `&jsonp=?` to the API call.
+
+Example usage: http://api.jquery.com/jQuery.getJSON/
+
+## API Methods
+
+### Groups
+Pads can belong to a group. The padID of grouppads is starting with a groupID like g.asdfasdfasdfasdf$test
+
+* **createGroup()** creates a new group <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {groupID: g.s8oes9dhwrvt0zif}}`
+
+* **createGroupIfNotExistsFor(groupMapper)** this functions helps you to map your application group ids to etherpad lite group ids <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {groupID: g.s8oes9dhwrvt0zif}}`
+
+* **deleteGroup(groupID)** deletes a group <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: null}`
+  * `{code: 1, message:"groupID does not exist", data: null}`
+
+* **listPads(groupID)** returns all pads of this group<br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {padIDs : ["g.s8oes9dhwrvt0zif$test", "g.s8oes9dhwrvt0zif$test2"]}`
+  * `{code: 1, message:"groupID does not exist", data: null}`
+
+* **createGroupPad(groupID, padName [, text])** creates a new pad in this group <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: null}`
+  * `{code: 1, message:"pad does already exist", data: null}`
+  * `{code: 1, message:"groupID does not exist", data: null}`
+
+* **listAllGroups()** lists all existing groups<br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {groupIDs: ["g.mKjkmnAbSMtCt8eL", "g.3ADWx6sbGuAiUmCy"]}}`
+  * `{code: 0, message:"ok", data: {groupIDs: []}}`
+
+### Author
+These authors are bound to the attributes the users choose (color and name). 
+
+* **createAuthor([name])** creates a new author <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
+
+* **createAuthorIfNotExistsFor(authorMapper [, name])** this functions helps you to map your application author ids to etherpad lite author ids <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
+
+* **listPadsOfAuthor(authorID)** returns an array of all pads this author contributed to<br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {padIDs: ["g.s8oes9dhwrvt0zif$test", "g.s8oejklhwrvt0zif$foo"]}}`
+  * `{code: 1, message:"authorID does not exist", data: null}`
+
+* **getAuthorName(authorID)** Returns the Author Name of the author <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {authorName: "John McLear"}}`
+
+-> can't be deleted cause this would involve scanning all the pads where this author was
+
+### Session
+Sessions can be created between a group and an author. This allows an author to access more than one group. The sessionID will be set as a cookie to the client and is valid until a certain date. The session cookie can also contain multiple comma-seperated sessionIDs, allowing a user to edit pads in different groups at the same time. Only users with a valid session for this group, can access group pads. You can create a session after you authenticated the user at your web application, to give them access to the pads. You should save the sessionID of this session and delete it after the user logged out.
+
+* **createSession(groupID, authorID, validUntil)** creates a new session. validUntil is an unix timestamp in seconds <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {sessionID: "s.s8oes9dhwrvt0zif"}}`
+  * `{code: 1, message:"groupID doesn't exist", data: null}`
+  * `{code: 1, message:"authorID doesn't exist", data: null}`
+  * `{code: 1, message:"validUntil is in the past", data: null}`
+
+* **deleteSession(sessionID)** deletes a session <br><br>*Example returns:*
+  * `{code: 1, message:"ok", data: null}`
+  * `{code: 1, message:"sessionID does not exist", data: null}`
+
+* **getSessionInfo(sessionID)** returns informations about a session <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif", groupID: g.s8oes9dhwrvt0zif, validUntil: 1312201246}}`
+  * `{code: 1, message:"sessionID does not exist", data: null}`
+
+* **listSessionsOfGroup(groupID)** returns all sessions of a group <br><br>*Example returns:*
+  * `{"code":0,"message":"ok","data":{"s.oxf2ras6lvhv2132":{"groupID":"g.s8oes9dhwrvt0zif","authorID":"a.akf8finncvomlqva","validUntil":2312905480}}}`
+  * `{code: 1, message:"groupID does not exist", data: null}`
+
+* **listSessionsOfAuthor(authorID)** returns all sessions of an author <br><br>*Example returns:*
+  * `{"code":0,"message":"ok","data":{"s.oxf2ras6lvhv2132":{"groupID":"g.s8oes9dhwrvt0zif","authorID":"a.akf8finncvomlqva","validUntil":2312905480}}}`
+  * `{code: 1, message:"authorID does not exist", data: null}`
+
+### Pad Content
+
+Pad content can be updated and retrieved through the API
+
+* **getText(padID, [rev])** returns the text of a pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {text:"Welcome Text"}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **setText(padID, text)** sets the text of a pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: null}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+  * `{code: 1, message:"text too long", data: null}`
+
+* **getHTML(padID, [rev])** returns the text of a pad formatted as HTML<br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {html:"Welcome Text<br>More Text"}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+### Pad
+Group pads are normal pads, but with the name schema GROUPID$PADNAME. A security manager controls access of them and its forbidden for normal pads to include a $ in the name. 
+
+* **createPad(padID [, text])** creates a new (non-group) pad.  Note that if you need to create a group Pad, you should call **createGroupPad**.<br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: null}`
+  * `{code: 1, message:"pad does already exist", data: null}`
+
+* **getRevisionsCount(padID)** returns the number of revisions of this pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {revisions: 56}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **padUsersCount(padID)** returns the number of user that are currently editing this pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {padUsersCount: 5}}`
+
+* **padUsers(padID)** returns the list of users that are currently editing this pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {padUsers: [{colorId:"#c1a9d9","name":"username1","timestamp":1345228793126},{"colorId":"#d9a9cd","name":"Hmmm","timestamp":1345228796042}]}}`
+  * `{code: 0, message:"ok", data: {padUsers: []}}`
+
+* **deletePad(padID)** deletes a pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: null}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **getReadOnlyID(padID)** returns the read only link of a pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {readOnlyID: "r.s8oes9dhwrvt0zif"}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **setPublicStatus(padID, publicStatus)** sets a boolean for the public status of a pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: null}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **getPublicStatus(padID)** return true of false <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {publicStatus: true}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **setPassword(padID, password)** returns ok or a error message <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: null}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **isPasswordProtected(padID)** returns true or false <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {passwordProtection: true}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **listAuthorsOfPad(padID)** returns an array of authors who contributed to this pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {authorIDs : ["a.s8oes9dhwrvt0zif", "a.akf8finncvomlqva"]}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+
+* **getLastEdited(padID)** returns the timestamp of the last revision of the pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {lastEdited: 1340815946602}}`
+  * `{code: 1, message:"padID does not exist", data: null}`
+  
+* **sendClientsMessage(padID, msg)** sends a custom message of type `msg` to the pad <br><br>*Example returns:*
+  * `{code: 0, message:"ok", data: {}}`
+  * `{code: 1, message:"padID does not exist", data: null}`

doc/api/pluginfw.adoc

@@ -1,22 +0,0 @@
-== Plugin Framework
-
-`require("ep_etherpad-lite/static/js/plugingfw/plugins")`
-
-=== plugins.update
-
-`require("ep_etherpad-lite/static/js/plugingfw/plugins").update()` will use npm
-to list all installed modules and read their ep.json files, registering the
-contained hooks. A hook registration is a pair of a hook name and a function
-reference (filename for require() plus function name)
-
-=== hooks.callAll
-
-`require("ep_etherpad-lite/static/js/plugingfw/hooks").callAll("hook_name",
-{argname:value})` will call all hook functions registered for `hook_name` with
-`{argname:value}`.
-
-=== hooks.aCallAll
-
-?
-
-=== ...

doc/api/toolbar.adoc

@@ -1,49 +0,0 @@
-== Toolbar controller
-src/node/utils/toolbar.js
-
-=== button(opts)
- * {Object} `opts`
-   * `command` - this command fill be fired on the editbar on click
-   * `localizationId` - will be set as `data-l10-id`
-   * `class` - here you can add additional classes to the button
-
-Returns: {Button}
-
-Example:
-
-[source, javascript]
-----
-var orderedlist = toolbar.button({
-  command: "insertorderedlist",
-  localizationId: "pad.toolbar.ol.title",
-  class: "buttonicon buttonicon-insertorderedlist"
-})
-----
-
-You can also create buttons with text:
-
-[source, javascript]
-----
-var myButton = toolbar.button({
-  command: "myButton",
-  localizationId: "myPlugin.toolbar.myButton",
-  class: "buttontext"
-})
-----
-
-=== selectButton(opts)
- * {Object} `opts`
-   * `id` - id of the menu item
-   * `selectId` - id of the select element
-   * `command` - this command fill be fired on the editbar on change
-
-Returns: {SelectButton}
-
-=== SelectButton.addOption(value, text, attributes)
- * {String} value - The value of this option
- * {String} text - the label text used for this option
- * {Object} attributes - any additional html attributes go here (e.g. `data-l10n-id`)
-
-=== registerButton(name, item)
-  * {String} name - used to reference the item in the toolbar config in settings.json
-  * {Button|SelectButton} item - the button to add

doc/assets/style.css

@@ -1,69 +0,0 @@
-body {
-  border-top: solid #44b492 5pt;
-  line-height: 150%;
-  font-family: "Quicksand", sans-serif;
-  color: #313b4a;
-  max-width: 1440px;
-  margin: 0 auto;
-  padding: 20px;
-}
-
-a {
-  color: #555;
-}
-
-h1,
-h2 {
-  color: #44b492;
-  line-height: 100%;
-}
-
-h2 {
-  font-size: 48px;
-}
-
-h3 {
-  font-size: 1.8rem;
-}
-
-h4 {
-  font-size: 1.5rem;
-}
-
-h5 {
-  font-size: 1.2rem;
-}
-
-a:hover {
-  color: #44b492;
-}
-
-pre {
-  background-color: #e0e0e0;
-  padding: 20px;
-}
-
-code {
-  background-color: #e0e0e0;
-}
-
-img {
-  max-width: 100%;
-}
-
-table,
-th,
-td {
-  text-align: left;
-  border: 1px solid gray;
-  border-collapse: collapse;
-}
-
-th {
-  padding: 0.5em;
-  background: #eee;
-}
-
-td {
-  padding: 0.5em;
-}

doc/cookies.adoc

@@ -1,74 +0,0 @@
-== Cookies
-Cookies used by Etherpad.
-
-[cols="1,1,1,1,1,1,1,1"]
-|===
-
-| Name
-| Sample value
-| Domain
-| Path
-| Expires/max-age
-| Http-only
-| Secure
-|  Usage description
-|express_sid
-| s%3A7yCNjRmTW8ylGQ53I2IhOwYF9...
-| example.org
-|/
-| Session
-| true
-| true
-| Session ID of the https://expressjs.com[Express web framework]. When Etherpad is behind a reverse proxy, and an administrator wants to use session stickiness, he may use this cookie. If you are behind a reverse proxy, please remember to set `trustProxy: true` in `settings.json`. Set in https://github.com/ether/etherpad-lite/blob/01497aa399690e44393e91c19917d11d025df71b/src/node/hooks/express/webaccess.js#L131[webaccess.js#L131].
-
-
-|language
-| en
-| example.org
-| /
-| Session
-| false
-| true
-| The language of the UI (e.g.: `en-GB`, `it`). Set in https://github.com/ether/etherpad-lite/blob/01497aa399690e44393e91c19917d11d025df71b/src/static/js/pad_editor.js#L111[pad_editor.js#L111].
-
-
-|prefs / prefsHttp
-| %7B%22epThemesExtTheme%22...
-| example.org
-| /p
-| year 3000
-| false
-| true
-| Client-side preferences (e.g.: font family, chat always visible, show authorship colors, ...). Set in https://github.com/ether/etherpad-lite/blob/01497aa399690e44393e91c19917d11d025df71b/src/static/js/pad_cookie.js#L49[pad_cookie.js#L49]. `prefs` is used if Etherpad is accessed over HTTPS, `prefsHttp` if accessed over HTTP. For more info see https://github.com/ether/etherpad-lite/issues/3179.
-
-
-
-|token
-| t.tFzkihhhBf4xKEpCK3PU
-| example.org
-| /
-| 60 days
-| false
-| true
-| A random token representing the author, of the form `t.randomstring_of_lenght_20`. The random string is generated by the client, at https://github.com/ether/etherpad-lite/blob/01497aa399690e44393e91c19917d11d025df71b/src/static/js/pad.js#L55-L66[pad.js#L55-L66]. This cookie is always set by the client at https://github.com/ether/etherpad-lite/blob/01497aa399690e44393e91c19917d11d025df71b/src/static/js/pad.js#L153-L158[pad.js#L153-L158] without any solicitation from the server. It is used for all the pads accessed via the web UI (not used for the HTTP API). On the server side, its value is accessed at https://github.com/ether/etherpad-lite/blob/01497aa399690e44393e91c19917d11d025df71b/src/node/db/SecurityManager.js#L33[SecurityManager.js#L33].
-|===
-
-For more info, visit the related discussion at https://github.com/ether/etherpad-lite/issues/3563.
-
-Etherpad HTTP API clients may make use (if they choose so) to send another cookie:
-
-
-[cols="1,1,1"]
-|===
-
-| Name
-| Sample value
-| Domain
-| Usage description
-
-
-| sessionID
-| s.1c70968b333b25476a2c7bdd0e0bed17
-| example.org
-| Sessions can be created between a group and an author. This allows an author to access more than one group. The sessionID will be set as a cookie to the client and is valid until a certain date. The session cookie can also contain multiple comma-separated sessionIDs, allowing a user to edit pads in different groups at the same time. More info - https://github.com/ether/etherpad-lite/blob/develop/doc/api/http_api.md#session
-|===

doc/database.md

@@ -1,21 +1,21 @@
-== Database structure
+# Database structure
 
-=== Keys and their values
+## Keys and their values
 
-==== groups
+### groups
 A list of all existing groups (a JSON object with groupIDs as keys and `1` as values).
 
-==== pad:$PADID
-Contains all information about pads
+### pad:$PADID
+Saves all informations about pads
 
 * **atext** - the latest attributed text
 * **pool** - the attribute pool
 * **head** - the number of the latest revision
 * **chatHead** - the number of the latest chat entry
 * **public** - flag that disables security for this pad
-* **passwordHash** - string that contains a salted sha512 sum of this pad's password
+* **passwordHash** - string that contains a bcrypt hashed password for this pad
 
-==== pad:$PADID:revs:$REVNUM
+### pad:$PADID:revs:$REVNUM
 Saves a revision $REVNUM of pad $PADID
 
 * **meta**
@@ -23,50 +23,45 @@ Saves a revision $REVNUM of pad $PADID
   * **timestamp** - the timestamp of when this revision was created
 * **changeset** - the changeset of this revision
 
-==== pad:$PADID:chat:$CHATNUM
-Saves a chat entry with num $CHATNUM of pad $PADID
+### pad:$PADID:chat:$CHATNUM
+Saves a chatentry with num $CHATNUM of pad $PADID
 
 * **text** - the text of this chat entry
-* **userId** - the authorID of this chat entry
+* **userId** - the autorID of this chat entry
 * **time** - the timestamp of this chat entry
 
-==== pad2readonly:$PADID
+### pad2readonly:$PADID
 Translates a padID to a readonlyID
-
-==== readonly2pad:$READONLYID
+### readonly2pad:$READONLYID
 Translates a readonlyID to a padID
-
-==== token2author:$TOKENID
+### token2author:$TOKENID
 Translates a token to an authorID
-
-==== globalAuthor:$AUTHORID
+### globalAuthor:$AUTHORID
 Information about an author
 
 * **name** - the name of this author as shown in the pad
 * **colorID** - the colorID of this author as shown in the pad
 
-==== mapper2group:$MAPPER
-Maps an external application identifier to an internal group
-
-==== mapper2author:$MAPPER
-Maps an external application identifier to an internal author
-
-==== group:$GROUPID
+### mapper2group:$MAPPER
+Maps an external application identifier to an internal group 
+### mapper2author:$MAPPER
+Maps an external application identifier to an internal author 
+### group:$GROUPID
 a group of pads
 
 * **pads** - object with pad names in it, values are 1
-==== session:$SESSIONID
+### session:$SESSIONID
 a session between an author and a group
 
 * **groupID** - the groupID the session belongs too
 * **authorID** - the authorID the session belongs too
 * **validUntil** - the timestamp until this session is valid
 
-==== author2sessions:$AUTHORID
+### author2sessions:$AUTHORID
 saves the sessions of an author
 
 * **sessionsIDs** - object with sessionIDs in it, values are 1
 
-==== group2sessions:$GROUPID
+### group2sessions:$GROUPID
 
 * **sessionsIDs** - object with sessionIDs in it, values are 1

doc/docker.adoc

@@ -1,538 +0,0 @@
-== Docker
-
-The official Docker image is available on https://hub.docker.com/r/etherpad/etherpad.
-
-=== Downloading from Docker Hub
-If you are ok downloading a https://hub.docker.com/r/etherpad/etherpad[prebuilt image from Docker Hub], these are the commands:
-
-[source, bash]
-----
-# gets the latest published version
-docker pull etherpad/etherpad
-
-# gets a specific version
-docker pull etherpad/etherpad:1.8.0
-----
-
-=== Build a personalized container
-
-If you want to use a personalized settings file, **you will have to rebuild your image**.
-All of the following instructions are as a member of the `docker` group.
-By default, the Etherpad Docker image is built and run in `production` mode: no development dependencies are installed, and asset bundling speeds up page load time.
-
-==== Rebuilding with custom settings
-Edit `<BASEDIR>/settings.json.docker` at your will. When rebuilding the image, this file will be copied inside your image and renamed to `settings.json`.
-
-**Each configuration parameter can also be set via an environment variable**, using the syntax `"${ENV_VAR}"` or `"${ENV_VAR:default_value}"`. For details, refer to `settings.json.template`.
-
-==== Rebuilding including some plugins
-If you want to install some plugins in your container, it is sufficient to list them in the ETHERPAD_PLUGINS build variable.
-The variable value has to be a space separated, double quoted list of plugin names (see examples).
-
-Some plugins will need personalized settings. Just refer to the previous section, and include them in your custom `settings.json.docker`.
-
-==== Rebuilding including export functionality for DOC/PDF/ODT
-
-If you want to be able to export your pads to DOC/PDF/ODT files, you can install
-either Abiword or Libreoffice via setting a build variable.
-
-===== Via Abiword
-
-For installing Abiword, set the `INSTALL_ABIWORD` build variable to any value.
-
-Also, you will need to configure the path to the abiword executable
-via setting the `abiword` property in `<BASEDIR>/settings.json.docker` to
-`/usr/bin/abiword` or via setting the environment variable  `ABIWORD` to
-`/usr/bin/abiword`.
-
-===== Via Libreoffice
-
-For installing Libreoffice instead, set the `INSTALL_SOFFICE` build variable
-to any value.
-
-Also, you will need to configure the path to the libreoffice executable
-via setting the `soffice` property in `<BASEDIR>/settings.json.docker` to
-`/usr/bin/soffice` or via setting the environment variable  `SOFFICE` to
-`/usr/bin/soffice`.
-
-==== Examples
-
-Build a Docker image from the currently checked-out code:
-
-[source,bash]
-----
-docker build --tag <YOUR_USERNAME>/etherpad .
-----
-
-Include two plugins in the container:
-
-[source,bash]
-----
-docker build --build-arg ETHERPAD_PLUGINS="ep_comments_page ep_author_neat" --tag <YOUR_USERNAME>/etherpad .
-----
-
-=== Running your instance:
-
-To run your instance:
-
-[source,bash]
-----
-docker run --detach --publish <DESIRED_PORT>:9001 <YOUR_USERNAME>/etherpad
-----
-
-And point your browser to `http://<YOUR_IP>:<DESIRED_PORT>`
-
-=== Options available by default
-
-The `settings.json.docker` available by default allows to control almost every setting via environment variables.
-
-==== General
-
-[cols="1,1,1"]
-|===
-| Variable
-| Description
-| Default
-| `TITLE`
-| The name of the instance
-| `Etherpad`
-
-| `FAVICON`
-| favicon default name, or a fully specified URL to your own favicon
-| `favicon.ico`
-| `DEFAULT_PAD_TEXT`
-| The default text of a pad
-| `Welcome to Etherpad! This pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents! Get involved with Etherpad at https://etherpad.org`
-
-| `IP`
-| IP which etherpad should bind at. Change to `::` for IPv6
-| `0.0.0.0`
-| `PORT`
-| port which etherpad should bind at
-| `9001`
-| `ADMIN_PASSWORD`
-| the password for the `admin` user (leave unspecified if you do not want to create it)
-|
-| `USER_PASSWORD`
-| the password for the first user `user` (leave unspecified if you do not want to create it)
-|
-|===
-
-==== Database
-
-[cols="1,1,1"]
-|===
-| Variable
-| Description
-| Default
-
-| `DB_TYPE`     | a database supported by https://www.npmjs.com/package/ueberdb2 | not set, thus will fall back to `DirtyDB` (please choose one instead)
-| `DB_HOST`     | the host of the database
-|
-
-| `DB_PORT`
-| the port of the database
-|
-
-| `DB_NAME`
-| the database name
-|
-
-| `DB_USER`
-| a database user with sufficient permissions to create tables
-|
-
-| `DB_PASS`
-| the password for the database username
-|
-
-| `DB_CHARSET`
-| the character set for the tables (only required for MySQL)
-|
-
-| `DB_FILENAME`
-| in case `DB_TYPE` is `DirtyDB` or `sqlite`, the database file.
-| `var/dirty.db`, `var/etherpad.sq3`
-|===
-
-If your database needs additional settings, you will have to use a personalized `settings.json.docker` and rebuild the container (or otherwise put the updated `settings.json` inside your image).
-
-
-==== Pad Options
-
-[cols="1,1,1"]
-|===
-
-| Variable
-| Description
-| Default
-
-
-| `PAD_OPTIONS_NO_COLORS`
-|
-| `false`
-
-
-| `PAD_OPTIONS_SHOW_CONTROLS`
-|
-| `true`
-
-| `PAD_OPTIONS_SHOW_CHAT`
-|
-| `true`
-
-| `PAD_OPTIONS_SHOW_LINE_NUMBERS`
-|
-| `true`
-
-| `PAD_OPTIONS_USE_MONOSPACE_FONT`
-|
-| `false`
-
-| `PAD_OPTIONS_USER_NAME`
-|
-| `null`
-
-| `PAD_OPTIONS_USER_COLOR`
-|
-| `null`
-
-| `PAD_OPTIONS_RTL`
-|
-| `false`
-
-| `PAD_OPTIONS_ALWAYS_SHOW_CHAT`
-|
-| `false`
-
-| `PAD_OPTIONS_CHAT_AND_USERS`
-|
-|  `false`
-
-| `PAD_OPTIONS_LANG`
-|
-| `null`
-|===
-
-==== Shortcuts
-
-[cols="1,1,1"]
-|===
-| Variable
-| Description
-| Default
-
-
-| `PAD_SHORTCUTS_ENABLED_ALT_F9`
-| focus on the File Menu and/or editbar
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_ALT_C`
-| focus on the Chat window
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_S`
-| save a revision
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_Z`
-| undo/redo
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_Y`
-| redo
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_I`
-| italic
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_B`
-| bold
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_U`
-| underline
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_H`
-| backspace
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_5`
-| strike through
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_1`
-| ordered list
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_2`
-| shows a gritter popup showing a line author
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_L`
-| unordered list
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_N`
-| ordered list
-|`true`
-
-| `PAD_SHORTCUTS_ENABLED_CMD_SHIFT_C`
-| clear authorship
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_DELETE`
-|
-| `true`
-
-
-| `PAD_SHORTCUTS_ENABLED_RETURN`
-|
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_ESC`
-| in mozilla versions 14-19 avoid reconnecting pad
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_TAB`
-| indent
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_CTRL_HOME`
-| scroll to top of pad
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_PAGE_UP`
-|
-| `true`
-
-| `PAD_SHORTCUTS_ENABLED_PAGE_DOWN`
-|
-| `true`
-|===
-
-==== Skins
-
-You can use the UI skin variants builder at `/p/test#skinvariantsbuilder`
-
-For the colibris skin only, you can choose how to render the three main containers:
-  * toolbar (top menu with icons)
-  * editor (containing the text of the pad)
-  * background (area outside of editor, mostly visible when using page style)
-
-For each of the 3 containers you can choose 4 color combinations:
-   * super-light
-   * light
-   * dark
-   * super-dark
-
-For the editor container, you can also make it full width by adding `full-width-editor` variant (by default editor is rendered as a page, with a max-width of 900px).
-
-[cols="1,1,1"]
-|===
-| Variable
-| Description
-| Default
-
-| `SKIN_NAME`
-| either `no-skin`, `colibris` or an existing directory under `src/static/skins`
-| `colibris`
-
-| `SKIN_VARIANTS`
-| multiple skin variants separated by spaces
-| `super-light-toolbar super-light-editor light-background`
-|===
-
-==== Logging
-
-[cols="1,1,1"]
-|===
-| Variable
-| Description
-| Default
-
-
-| `LOGLEVEL`
-| valid values are `DEBUG`, `INFO`, `WARN` and `ERROR` | `INFO`
-
-| `DISABLE_IP_LOGGING`
-| Privacy: disable IP logging
-| `false`
-|===
-
-==== Advanced
-
-[cols="1,1,1"]
-|===
-| Variable
-| Description
-| Default
-
-|`COOKIE_KEY_ROTATION_INTERVAL`
-|How often (ms) to rotate in a new secret for signing cookies
-|`86400000` (1 day)
-
-| `COOKIE_SAME_SITE`
-| Value of the SameSite cookie property.
-| `"Lax"`
-
-| `COOKIE_SESSION_LIFETIME`
-| How long (ms) a user can be away before they must log in again.
-| `864000000` (10 days)
-
-| `COOKIE_SESSION_REFRESH_INTERVAL`
-| How often (ms) to write the latest cookie expiration time.
-| `86400000` (1 day)
-
-| `SHOW_SETTINGS_IN_ADMIN_PAGE`
-| hide/show the settings.json in admin page
-| `true`
-
-| `TRUST_PROXY`
-| set to `true` if you are using a reverse proxy in front of Etherpad (for example: Traefik for SSL termination via Let's Encrypt). This will affect security and correctness of the logs if not done
-| `false`
-
-| `IMPORT_MAX_FILE_SIZE`
-| maximum allowed file size when importing a pad, in bytes.
-| `52428800` (50 MB)
-
-| `IMPORT_EXPORT_MAX_REQ_PER_IP`
-| maximum number of import/export calls per IP.
-| `10`
-
-| `IMPORT_EXPORT_RATE_LIMIT_WINDOW`
-| the call rate for import/export requests will be estimated in this time window (in milliseconds)
-| `90000`
-
-| `COMMIT_RATE_LIMIT_DURATION`
-| duration of the rate limit window for commits by individual users/IPs (in seconds)                               | `1`
-
-| `COMMIT_RATE_LIMIT_POINTS`
-| maximum number of changes per IP to allow during the rate limit window
-| `10`
-
-| `SUPPRESS_ERRORS_IN_PAD_TEXT`
-| Should we suppress errors from being visible in the default Pad Text?
-| `false
-
-| `REQUIRE_SESSION`
-| If this option is enabled, a user must have a session to access pads. This effectively allows only group pads to be accessed.
-| `false`
-
-| `EDIT_ONLY`
-| Users may edit pads but not create new ones. Pad creation is only via the API. This applies both to group pads and regular pads.
-| `false`
-
-| `MINIFY`
-| If true, all css & js will be minified before sending to the client. This will improve the loading performance massively, but makes it difficult to debug the javascript/css
-| `true`
-
-| `MAX_AGE`
-| How long may clients use served javascript code (in seconds)? Not setting this may cause problems during deployment. Set to 0 to disable caching.
-| `21600` (6 hours)
-
-| `ABIWORD`
-| Absolute path to the Abiword executable. Abiword is needed to get advanced import/export features of pads. Setting it to null disables Abiword and will only allow plain text and HTML import/exports.
-| `null`
-
-| `SOFFICE`
-| This is the absolute path to the soffice executable. LibreOffice can be used in lieu of Abiword to export pads. Setting it to null disables LibreOffice exporting.
-| `null`
-
-| `TIDY_HTML`
-| Path to the Tidy executable. Tidy is used to improve the quality of exported pads. Setting it to null disables Tidy.
-| `null`
-
-| `ALLOW_UNKNOWN_FILE_ENDS`
-| Allow import of file types other than the supported ones: txt, doc, docx, rtf, odt, html & htm
-| `true`
-
-| `REQUIRE_AUTHENTICATION`
-| This setting is used if you require authentication of all users. Note: "/admin" always requires authentication.
-| `false`
-
-| `REQUIRE_AUTHORIZATION`
-| Require authorization by a module, or a user with is_admin set, see below.
-| `false`
-
-| `AUTOMATIC_RECONNECTION_TIMEOUT`
-| Time (in seconds) to automatically reconnect pad when a "Force reconnect" message is shown to user. Set to 0 to disable automatic reconnection.
-| `0`
-
-| `FOCUS_LINE_PERCENTAGE_ABOVE`
-| Percentage of viewport height to be additionally scrolled. e.g. 0.5, to place caret line in the middle of viewport, when user edits a line above of the viewport. Set to 0 to disable extra scrolling
-| `0`
-
-| `FOCUS_LINE_PERCENTAGE_BELOW`
-| Percentage of viewport height to be additionally scrolled. e.g. 0.5, to place caret line in the middle of viewport, when user edits a line below of the viewport. Set to 0 to disable extra scrolling
-| `0`
-
-| `FOCUS_LINE_PERCENTAGE_ARROW_UP`
-| Percentage of viewport height to be additionally scrolled when user presses arrow up in the line of the top of the viewport. Set to 0 to let the scroll to be handled as default by Etherpad
-| `0`
-
-| `FOCUS_LINE_DURATION`
-| Time (in milliseconds) used to animate the scroll transition. Set to 0 to disable animation
-| `0`
-
-| `FOCUS_LINE_CARET_SCROLL`
-| Flag to control if it should scroll when user places the caret in the last line of the viewport
-| `false`
-
-| `SOCKETIO_MAX_HTTP_BUFFER_SIZE`
-| The maximum size (in bytes) of a single message accepted via Socket.IO. If a client sends a larger message, its connection gets closed to prevent DoS (memory exhaustion) attacks.
-| `10000`
-
-| `LOAD_TEST`
-| Allow Load Testing tools to hit the Etherpad Instance. WARNING: this will disable security on the instance.
-| `false`
-
-| `DUMP_ON_UNCLEAN_EXIT`
-| Enable dumping objects preventing a clean exit of Node.js. WARNING: this has a significant performance impact.
-| `false`
-
-| `EXPOSE_VERSION`
-| Expose Etherpad version in the web interface and in the Server http header. Do not enable on production machines.
-| `false`
-|===
-
-==== Examples
-
-Use a Postgres database, no admin user enabled:
-
-[source,bash]
-----
-docker run -d \
-	--name etherpad         \
-	-p 9001:9001            \
-	-e 'DB_TYPE=postgres'   \
-	-e 'DB_HOST=db.local'   \
-	-e 'DB_PORT=4321'       \
-	-e 'DB_NAME=etherpad'   \
-	-e 'DB_USER=dbusername' \
-	-e 'DB_PASS=mypassword' \
-	etherpad/etherpad
-----
-
-Run enabling the administrative user `admin`:
-
-[source,bash]
-----
-docker run -d \
-	--name etherpad \
-	-p 9001:9001 \
-	-e 'ADMIN_PASSWORD=supersecret' \
-	etherpad/etherpad
-----
-
-Run a test instance running DirtyDB on a persistent volume:
-
-[source, bash]
-----
-docker run -d \
-	-v etherpad_data:/opt/etherpad-lite/var \
-	-p 9001:9001 \
-	etherpad/etherpad
-----

doc/documentation.md

@@ -1,6 +1,8 @@
-== About this Documentation
+# About this Documentation
 
-The goal of this documentation is to comprehensively explain Etherpad,
+<!-- type=misc -->
+
+The goal of this documentation is to comprehensively explain Etherpad-Lite,
 both from a reference as well as a conceptual point of view.
 
 Where appropriate, property types, method arguments, and the arguments
@@ -8,6 +10,6 @@ provided to event handlers are detailed in a list underneath the topic
 heading.
 
 Every `.html` file is generated based on the corresponding
-`.md` file in the `doc/api/` folder in the source tree. The
-documentation is generated using the `src/bin/doc/generate.js` program.
-The HTML template is located at `doc/template.html`.
+`.markdown` file in the `doc/api/` folder in the source tree. The
+documentation is generated using the `tools/doc/generate.js` program.
+The HTML template is located at `doc/template.html`.

doc/easysync/README.md

@@ -1,2 +1,2 @@
 # About this folder
-We put all documentations we found about the original Etherpad together in this folder. Most of this is still valid for the current (node.js based) Etherpad.
+We put all documentations we found about the old Etherpad together in this folder. Most of this is still valid for Etherpad Lite

doc/easysync/easysync-full-description.tex

@@ -83,9 +83,9 @@ For any two changesets $A$, $B$ such that
 
 \begin{itemize}
 \item[] $A=(n_1\rightarrow n_2)[\cdots]$
-\item[] $B=(n_2\rightarrow n_3)[\cdots]$
+\item[] $A=(n_2\rightarrow n_3)[\cdots]$
 \end{itemize}
-it is clear that there is a third changeset $C=(n_1\rightarrow n_3)[\cdots]$ such that applying $C$ to a document $X$ yields the same resulting document as does applying $A$ and then $B$.  In this case, we write $AB=C$.
+it is clear that there is a third changeset $C=(n_1\rightarrow n_3)[\cdots]$ such that applying $C$ to a document $X$ yeilds the same resulting document as does applying $A$ and then $B$.  In this case, we write $AB=C$.
 
 Given the representation from Section \ref{representation}, it is straightforward to compute the composition of two changesets.
 
@@ -93,18 +93,18 @@ Given the representation from Section \ref{representation}, it is straightforwar
 
 Now we come to realtime document editing.  Suppose two different users make two different changes to the same document at the same time.  It is impossible to compose these changes.    For example, if we have the document $X$ of length $n$, we may have $A=(n\rightarrow n_a)[\ldots n_a \mathrm{characters}]$,  $B=(n\rightarrow n_b)[\ldots n_b \mathrm{characters}]$ where $n\neq n_a\neq n_b$.
 
-It is impossible to compute $(XA)B$ because $B$ can only be applied to a document of length $n$, and $(XA)$ has length $n_a$.  Similarly, $A$ cannot be applied to $(XB)$ because $(XB)$ has length $n_b$.
+It is impossible to compute $(XA)B$ because $B$ can only be applied to a document of length $n$, and $(XA)$ has length $n_a$.  Similarly, $A$ cannot be appliet to $(XB)$ because $(XB)$ has length $n_b$.
 
-This is where \emph{merging} comes in.  Merging takes two changesets that apply to the same initial document (and that cannot be composed), and computes a single new changeset that preserves the intent of both changes.  The merge of $A$ and $B$ is written as $m(A,B)$.  For the Etherpad system to work, we require that $m(A,B)=m(B,A)$.
+This is where \emph{merging} comes in.  Merging takes two changesets that apply to the same initial document (and that cannot be composed), and computes a single new changeset that presevers the intent of both changes.  The merge of $A$ and $B$ is written as $m(A,B)$.  For the Etherpad system to work, we require that $m(A,B)=m(B,A)$.
 
-Aside from what we have said so far about merging, there are many different implementations that will lead to a workable system.  We have created one implementation for text that has the following constraints.
+Aside from what we have said so far about merging, there aremany different implementations that will lead to a workable system.  We have created one implementation for text that has the following constraints.
 
 \section{Follows} \label{follows}
 
 When users $A$ and $B$ have the same document $X$ on their screen, and they proceed to make respective changesets $A$ and $B$, it is no use to compute $m(A,B)$, because $m(A,B)$ applies to document $X$, but the users are already looking at document $XA$ and $XB$.  What we really want is to compute $B'$ and $A'$ such that
 $$XAB' = XBA' = Xm(A,B)$$
 
-``Following'' computes these $B'$ and $A'$ changesets.  The definition of the ``follow'' function $f$ is such that $Af(A,B)=Bf(B,A)=m(A,B)=m(B,A)$.  When we compute $f(A,B)$
+``Following'' computes these $B'$ and $A'$ changesets.  The definition of the ``follow'' function $f$ is such that $Af(A,B)=Bf(B,A)=m(A,B)=m(B,A)$.  When we computer $f(A,B)$.
 \begin{itemize}
 \item Insertions in $A$ become retained characters in $f(A,B)$
 \item Insertions in $B$ become insertions in $f(A,B)$
@@ -156,7 +156,7 @@ server always.  (This may distinguish from prior art?)
 The other critical design feature of the system is that
 \emph{A client must always be able to edit their local
   copy of the document, so the user is never blocked from
-  typing because of waiting to send or receive data.}
+  typing because of waiting to to send or receive data.}
 
 \section{Client State}
 
@@ -329,7 +329,7 @@ with:
 \end{enumerate}
 
 \subsection{Respond to client connect}
-When a server receives a connection request from a client,
+When a server recieves a connection request from a client,
 it receives the client's unique ID and stores that in the
 server's set of connected clients.  It then sends the
 client the contents of HEADTEXT, and the corresponding

doc/easysync/easysync-notes.txt

@@ -79,14 +79,14 @@ Here are descriptions of the operations, where capital letters are variables:
          kept MUST be a newline, and the final newline of the document is allowed.
 "*I"   : Apply attribute I from the pool to the following +, =, |+, or |= command.
          In other words, any number of * ops can come before a +, =, or | but not
-         between a | and the corresponding + or =.
+	 between a | and the corresponding + or =.
          If +, text is inserted having this attribute.  If =, text is kept but with
-         the attribute applied as an attribute addition or removal.
-         Consecutive attributes must be sorted lexically by (key,value) with key
-         and value taken as strings.  It's illegal to have duplicate keys
-         for (key,value) pairs that apply to the same text.  It's illegal to
-         have an empty value for a key in the case of an insertion (+), the
-         pair should just be omitted.
+	 the attribute applied as an attribute addition or removal.
+	 Consecutive attributes must be sorted lexically by (key,value) with key
+	 and value taken as strings.  It's illegal to have duplicate keys
+	 for (key,value) pairs that apply to the same text.  It's illegal to
+	 have an empty value for a key in the case of an insertion (+), the
+	 pair should just be omitted.
 
 Characters from the source text that aren't accounted for are assumed to be kept
 with the same attributes.

doc/index.adoc

@@ -1,25 +0,0 @@
-:version: {VERSION}
-
-= Etherpad v{version} Manual & Documentation
-:stylesheet: assets/style.css
-:toc:
-:toclevels: 4
-:source-highlighter: highlight.js
-
-include::./documentation.adoc[]
-
-include::./stats.adoc[]
-
-include::./localization.adoc[]
-
-include::./docker.adoc[]
-
-include::./skins.adoc[]
-
-include::./api/api.adoc[]
-
-include::./plugins.adoc[]
-
-include::./cookies.adoc[]
-
-include::./database.adoc[]

doc/localization.adoc

@@ -1,134 +0,0 @@
-== Localization
-Etherpad provides a multi-language user interface, that's apart from your users' content, so users from different countries can collaborate on a single document, while still having the user interface displayed in their mother tongue.
-
-
-=== Translating
-We rely on https://translatewiki.net to handle the translation process for us, so if you'd like to help...
-
-1. Sign up at https://translatewiki.net
-2. Visit our https://translatewiki.net/wiki/Translating:Etherpad_lite[TWN project page]
-3. Click on `Translate Etherpad lite interface`
-4. Choose a target language, you'd like to translate our interface to, and hit `Fetch`
-5. Start translating!
-
-Translations will be send back to us regularly and will eventually appear in the next release.
-
-=== Implementation
-
-==== Server-side
-`/src/locales` contains files for all supported languages which contain the translated strings. Translation files are simple `*.json` files and look like this:
-
-[source,json]
-----
-{ 
-  "pad.modals.connected": "Connecté.",
-  "pad.modals.uderdup": "Ouvrir dans une nouvelle fenêtre.",
-  "pad.toolbar.unindent.title": "Dèsindenter",
-  "pad.toolbar.undo.title": "Annuler (Ctrl-Z)",
-  "timeslider.pageTitle": "{{appTitle}} Curseur temporel",
-  ...
-}
-----
-
-Each translation consists of a key (the id of the string that is to be translated) and the translated string. Terms in curly braces must not be touched but left as they are, since they represent a dynamically changing part of the string like a variable. Imagine a message welcoming a user: `Welcome, {{userName}}!` would be translated as `Ahoy, {{userName}}!` in pirate.
-
-==== Client-side
-We use a `language` cookie to save your language settings if you change them. If you don't, we autodetect your locale using information from your browser. Then, the preferred language is fed into a library called https://github.com/marcelklehr/html10n.js[html10n.js], which loads the appropriate translations and applies them to our templates. Its features include translation params, pluralization, include rules and a nice javascript API.
-
-
-
-=== Localizing plugins
-
-==== 1. Mark the strings to translate
-
-In the template files of your plugin, change all hardcoded messages/strings...
-
-from:
-
-[source,html]
-----
-<option value="0">Heading 1</option>
-----
-to:
-
-[source,html]
-----
-<option data-l10n-id="ep_heading.h1" value="0"></option>
-----
-
-In the javascript files of your plugin, change all hardcoded messages/strings...
-
-from:
-
-[source,js]
-----
-alert ('Chat');
-----
-to:
-
-[source,js]
-----
-alert(window._('pad.chat'));
-----
-==== 2. Create translate files in the locales directory of your plugin
-
-* The name of the file must be the language code of the language it contains translations for (see https://joker-x.github.io/languages4translatewiki/test/[supported lang codes]; e.g. en ? English, es ? Spanish...)
-* The extension of the file must be `.json`
-* The default language is English, so your plugin should always provide `en.json`
-* In order to avoid naming conflicts, your message keys should start with the name of your plugin followed by a dot (see below)
-
-*ep_your-plugin/locales/en.json*
-
-[source, json]
-----
-{ 
-  "ep_your-plugin.h1": "Heading 1"
-}
-----
-
-*ep_your-plugin/locales/es.json*
-
-[source, json]
-----
-{ 
-  "ep_your-plugin.h1": "Título 1"
-}
-----
-
-Every time the http server is started, it will auto-detect your messages and merge them automatically with the core messages.
-
-==== Overwrite core messages
-
-You can overwrite Etherpad's core messages in your plugin's locale files.
-For example, if you want to replace `Chat` with `Notes`, simply add...
-
-*ep_your-plugin/locales/en.json*
-
-[source,json]
-----
-{ 
-  "ep_your-plugin.h1": "Heading 1",
-  "pad.chat": "Notes"
-}
-----
-
-=== Customization for Administrators
-
-As an Etherpad administrator, it is possible to overwrite core messages as well as messages in plugins. These include error messages, labels, and user instructions. Whereas the localization in the source code is in separate files separated by locale, an administrator's custom localizations are in `settings.json` under the `customLocaleStrings` key, with each locale separated by a sub-key underneath.
-
-For example, let's say you want to change the text on the "New Pad" button on Etherpad's home page. If you look in `locales/en.json` (or `locales/en-gb.json`) you'll see the key for this text is `"index.newPad"`. You could add the following to `settings.json`:
-
-[source,json]
-----
-  "customLocaleStrings": {
-    "fr": {
-      "index.newPad": "Créer un document"
-    },
-    "en-gb": {
-      "index.newPad": "Create a document"
-    },
-    "en": {
-      "index.newPad": "Create a document"
-    }
-  }
-----

doc/plugins.adoc

@@ -1,253 +0,0 @@
-== Plugins
-
-Etherpad allows you to extend its functionality with plugins. A plugin registers
-hooks (functions) for certain events (thus certain features) in Etherpad to
-execute its own functionality based on these events.
-
-Publicly available plugins can be found in the npm registry (see
-<https://npmjs.org>). Etherpad's naming convention for plugins is to prefix your
-plugins with `ep_`. So, e.g. it's `ep_flubberworms`. Thus you can install
-plugins from npm, using `npm install --no-save --legacy-peer-deps
-ep_flubberworm` in Etherpad's root directory.
-
-You can also browse to `http://yourEtherpadInstan.ce/admin/plugins`, which will
-list all installed plugins and those available on npm. It even provides
-functionality to search through all available plugins.
-
-=== Folder structure
-
-Ideally a plugin has the following folder structure:
-
-[source]
-----
-ep_<plugin>/
- ├ .github/
- │  └ workflows/
- │     └ npmpublish.yml  ◄─ GitHub workflow to auto-publish on push
- ├ static/
- │  ├ css/               ◄─ static .css files
- │  ├ images/            ◄─ static image files
- │  ├ js/
- │  │  └ index.js        ◄─ static client-side code
- │  └ tests/
- │     ├ backend/
- │     │  └ specs/       ◄─ backend (server) tests
- │     └ frontend/
- │        └ specs/       ◄─ frontend (client) tests
- ├ templates/            ◄─ EJS templates (.html, .js, .css, etc.)
- ├ locales/
- │  ├ en.json            ◄─ English (US) strings
- │  └ qqq.json           ◄─ optional hints for translators
- ├ .travis.yml           ◄─ Travis CI config
- ├ LICENSE
- ├ README.md
- ├ ep.json               ◄─ Etherpad plugin definition
- ├ index.js              ◄─ server-side code
- ├ package.json
- └ package-lock.json
-----
-
-If your plugin includes client-side hooks, put them in `static/js/`. If you're
-adding in CSS or image files, you should put those files in `static/css/ `and
-`static/image/`, respectively, and templates go into `templates/`. Translations
-go into `locales/`. Tests go in `static/tests/backend/specs/` and
-`static/tests/frontend/specs/`.
-
-A Standard directory structure like this makes it easier to navigate through
-your code. That said, do note, that this is not actually *required* to make your
-plugin run. If you want to make use of our i18n system, you need to put your
-translations into `locales/`, though, in order to have them integrated. (See
-"Localization" for more info on how to localize your plugin.)
-
-=== Plugin definition
-
-Your plugin definition goes into `ep.json`. In this file you register your hook
-functions, indicate the parts of your plugin and the order of execution. (A
-documentation of all available events to hook into can be found in chapter
-<<Server-side hooks>>.)
-
-[source,json]
-----
-{
-  "parts": [
-    {
-      "name": "nameThisPartHoweverYouWant",
-      "hooks": {
-        "authenticate": "ep_<plugin>/<file>:functionName1",
-        "expressCreateServer": "ep_<plugin>/<file>:functionName2"
-      },
-      "client_hooks": {
-        "acePopulateDOMLine": "ep_<plugin>/<file>:functionName3"
-      }
-    }
-  ]
-}
-----
-
-A hook function registration maps a hook name to a hook function specification.
-The hook function specification looks like `ep_example/file.js:functionName`. It
-consists of two parts separated by a colon: a module name to `require()` and the
-name of a function exported by the named module. See
-https://nodejs.org/docs/latest/api/modules.html#modules_module_exports[`module.exports`]
-for how to export a function.
-
-For the module name you can omit the `.js` suffix, and if the file is `index.js`
-you can use just the directory name. You can also omit the module name entirely,
-in which case it defaults to the plugin name (e.g., `ep_example`).
-
-You can also omit the function name. If you do, Etherpad will look for an
-exported function whose name matches the name of the hook (e.g.,
-`authenticate`).
-
-If either the module name or the function name is omitted (or both), the colon
-may also be omitted unless the provided module name contains a colon. (So if the
-module name is `C:\foo.js` then the hook function specification with the
-function name omitted would be `"C:\\foo.js:"`.)
-
-Examples: Suppose the plugin name is `ep_example`. All of the following are
-equivalent, and will cause the `authorize` hook to call the `exports.authorize`
-function in `index.js` from the `ep_example` plugin:
-
-* `"authorize": "ep_example/index.js:authorize"`
-* `"authorize": "ep_example/index.js:"`
-* `"authorize": "ep_example/index.js"`
-* `"authorize": "ep_example/index:authorize"`
-* `"authorize": "ep_example/index:"`
-* `"authorize": "ep_example/index"`
-* `"authorize": "ep_example:authorize"`
-* `"authorize": "ep_example:"`
-* `"authorize": "ep_example"`
-* `"authorize": ":authorize"`
-* `"authorize": ":"`
-* `"authorize": ""`
-
-==== Client hooks and server hooks
-
-There are server hooks, which will be executed on the server (e.g.
-`expressCreateServer`), and there are client hooks, which are executed on the
-client (e.g. `acePopulateDomLine`). Be sure to not make assumptions about the
-environment your code is running in, e.g. don't try to access `process`, if you
-know your code will be run on the client, and likewise, don't try to access
-`window` on the server...
-
-==== Styling
-
-When you install a client-side plugin (e.g. one that implements at least one
-client-side hook), the plugin name is added to the `class` attribute of the div
-`#editorcontainerbox` in the main window. This gives you the opportunity of
-tuning the appearance of the main UI in your plugin.
-
-For example, this is the markup with no plugins installed:
-
-[source,html]
-----
-<div id="editorcontainerbox" class="">
-----
-
-and this is the contents after installing `someplugin`:
-
-[source,html]
-----
-<div id="editorcontainerbox" class="ep_someplugin">
-----
-
-This feature was introduced in Etherpad **1.8**.
-
-==== Parts
-
-As your plugins become more and more complex, you will find yourself in the need
-to manage dependencies between plugins. E.g. you want the hooks of a certain
-plugin to be executed before (or after) yours. You can also manage these
-dependencies in your plugin definition file `ep.json`:
-
-[source,json]
-----
-{
-  "parts": [
-    {
-      "name": "onepart",
-      "pre": [],
-      "post": ["ep_onemoreplugin/partone"],
-      "hooks": {
-        "storeBar": "ep_monospace/plugin:storeBar",
-        "getFoo": "ep_monospace/plugin:getFoo"
-      }
-    },
-    {
-      "name": "otherpart",
-      "pre": ["ep_my_example/somepart", "ep_otherplugin/main"],
-      "post": [],
-      "hooks": {
-        "someEvent": "ep_my_example/otherpart:someEvent",
-        "another": "ep_my_example/otherpart:another"
-      }
-    }
-  ]
-}
-----
-
-Usually a plugin will add only one functionality at a time, so it will probably
-only use one `part` definition to register its hooks. However, sometimes you
-have to put different (unrelated) functionalities into one plugin. For this you
-will want use parts, so other plugins can depend on them.
-
-===== pre/post
-
-The `"pre"` and `"post"` definitions, affect the order in which parts of a
-plugin are executed. This ensures that plugins and their hooks are executed in
-the correct order.
-
-`"pre"` lists parts that must be executed *before* the defining part. `"post"`
-lists parts that must be executed *after* the defining part.
-
-You can, on a basic level, think of this as double-ended dependency listing. If
-you have a dependency on another plugin, you can make sure it loads before yours
-by putting it in `"pre"`. If you are setting up things that might need to be
-used by a plugin later, you can ensure proper order by putting it in `"post"`.
-
-Note that it would be far more sane to use `"pre"` in almost any case, but if
-you want to change config variables for another plugin, or maybe modify its
-environment, `"post"` could definitely be useful.
-
-Also, note that dependencies should *also* be listed in your package.json, so
-they can be `npm install`'d automagically when your plugin gets installed.
-
-=== Package definition
-
-Your plugin must also contain a https://docs.npmjs.com/files/package.json[package definition
-file], called package.json, in the
-project root - this file contains various metadata relevant to your plugin, such
-as the name and version number, author, project hompage, contributors, a short
-description, etc. If you publish your plugin on npm, these metadata are used for
-package search etc., but it's necessary for Etherpad plugins, even if you don't
-publish your plugin.
-
-[source,json]
-----
-{
-  "name": "ep_PLUGINNAME",
-  "version": "0.0.1",
-  "description": "DESCRIPTION",
-  "author": "USERNAME (REAL NAME) <MAIL@EXAMPLE.COM>",
-  "contributors": [],
-  "dependencies": {"MODULE": "0.3.20"},
-  "engines": {"node": ">=12.17.0"}
-}
-----
-
-=== Templates
-
-If your plugin adds or modifies the front end HTML (e.g. adding buttons or
-changing their functions), you should put the necessary HTML code for such
-operations in `templates/`, in files of type ".ejs", since Etherpad uses EJS for
-HTML templating. See the following link for more information about EJS:
-<https://github.com/visionmedia/ejs>.
-
-=== Writing and running front-end tests for your plugin
-
-Etherpad allows you to easily create front-end tests for plugins.
-
-1. Create a new folder: `%your_plugin%/static/tests/frontend/specs`
-2. Put your spec file in there. (Example spec files are visible in
-   `%etherpad_root_folder%/frontend/tests/specs`.)
-3. Visit http://yourserver.com/frontend/tests and your front-end tests will run.

doc/skins.adoc

@@ -1,19 +0,0 @@
-== Skins
-You can customize Etherpad appearance using skins.
-A skin is a directory located under `static/skins/<skin_name>`, with the following contents:
-
-* `index.js`: javascript that will be run in `/`
-* `index.css`: stylesheet affecting `/`
-* `pad.js`: javascript that will be run in `/p/:padid`
-* `pad.css`: stylesheet affecting `/p/:padid`
-* `timeslider.js`: javascript that will be run in `/p/:padid/timeslider`
-* `timeslider.css`: stylesheet affecting `/p/:padid/timeslider`
-* `favicon.ico`: overrides the default favicon
-* `robots.txt`: overrides the default `robots.txt`
-
-You can choose a skin changing the parameter `skinName` in `settings.json`.
-
-Since Etherpad **1.7.5**, two skins are included:
-
-* `no-skin`: an empty skin, leaving the default Etherpad appearance unchanged, that you can use as a guidance to develop your own.
-* `colibris`: a new, experimental skin, that will become the default in Etherpad 2.0.

doc/stats.adoc

@@ -1,19 +0,0 @@
-== Statistics
-
-Etherpad keeps track of the goings-on inside the edit machinery. If you'd like to have a look at this, just point your browser to `/stats`.
-
-We currently measure:
-
- - totalUsers (counter)
- - connects (meter)
- - disconnects (meter)
- - pendingEdits (counter)
- - edits (timer)
- - failedChangesets (meter)
- - httpRequests (timer)
- - http500 (meter)
- - memoryUsage (gauge)
-
-Under the hood, we are happy to rely on https://github.com/felixge/node-measured[measured] for all our metrics needs.
-
-To modify or simply access our stats in your plugin, simply `require('ep_etherpad-lite/stats')` which is a https://yaorg.github.io/node-measured/packages/measured-core/Collection.html[`measured.Collection`].

doc/template.html

@@ -0,0 +1,23 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>__SECTION__ Etherpad-Lite Manual &amp; Documentation</title>
+  <link rel="stylesheet" href="style.css">
+</head>
+<body class="apidoc" id="api-section-__FILENAME__">
+  <header id="header">
+    <h1>Etherpad-Lite Manual &amp; Documentation</h1>
+  </header>
+
+  <div id="toc">
+    <h2>Table of Contents</h2>
+    __TOC__
+  </div>
+
+  <div id="apicontent">
+    __CONTENT__
+  </div>
+
+</body>
+</html>

make_docs.js

@@ -1,58 +0,0 @@
-const { exec } = require('child_process');
-const fs = require('fs')
-const path = require('path')
-
-
-const pjson = require('./src/package.json')
-const VERSION=pjson.version
-console.log(`Building docs for version ${VERSION}`)
-
-const createDirIfNotExists = (dir) => {
-    if (!fs.existsSync(dir)){
-        fs.mkdirSync(dir)
-    }
-}
-
-
-function copyFolderSync(from, to) {
-   if(fs.existsSync(to)){
-       const stat = fs.lstatSync(to)
-       if (stat.isDirectory()){
-           fs.rmSync(to, { recursive: true })
-       }
-       else{
-           fs.rmSync(to)
-       }
-   }
-    fs.mkdirSync(to);
-    fs.readdirSync(from).forEach(element => {
-        if (fs.lstatSync(path.join(from, element)).isFile()) {
-            fs.copyFileSync(path.join(from, element), path.join(to, element))
-        } else {
-            copyFolderSync(path.join(from, element), path.join(to, element))
-        }
-    });
-}
-
-exec('asciidoctor -v', (err,stdout)=>{
-    if (err){
-        console.log('Please install asciidoctor')
-        console.log('https://asciidoctor.org/docs/install-toolchain/')
-        process.exit(1)
-    }
-});
-
-
-createDirIfNotExists('./out')
-createDirIfNotExists('./out/doc')
-createDirIfNotExists('./out/doc/api')
-
-
-
-exec(`asciidoctor -D out/doc doc/index.adoc */**.adoc -a VERSION=${VERSION}`)
-exec(`asciidoctor -D out/doc/api  ./doc/api/*.adoc -a VERSION=${VERSION}`)
-
-copyFolderSync('./doc/easysync', './out/doc/easysync')
-copyFolderSync('./doc/assets', './out/doc/assets')
-copyFolderSync('./doc/easysync', './out/doc/easysync')
-copyFolderSync('./doc/images', './out/doc/images')

node_modules/ep_etherpad-lite

@@ -1 +0,0 @@
-../src

settings.json.docker

@@ -1,662 +0,0 @@
-/**
- * THIS IS THE SETTINGS FILE THAT IS COPIED INSIDE THE DOCKER CONTAINER.
- *
- * By default, some runtime customizations are supported (see the
- * documentation).
- *
- * If you need more control, edit this file and rebuild the container.
- */
-
-/*
- * This file must be valid JSON. But comments are allowed
- *
- * Please edit settings.json, not settings.json.template
- *
- * Please note that starting from Etherpad 1.6.0 you can store DB credentials in
- * a separate file (credentials.json).
- *
- *
- * ENVIRONMENT VARIABLE SUBSTITUTION
- * =================================
- *
- * All the configuration values can be read from environment variables using the
- * syntax "${ENV_VAR}" or "${ENV_VAR:default_value}".
- *
- * This is useful, for example, when running in a Docker container.
- *
- * DETAILED RULES:
- *   - If the environment variable is set to the string "true" or "false", the
- *     value becomes Boolean true or false.
- *   - If the environment variable is set to the string "null", the value
- *     becomes null.
- *   - If the environment variable is set to the string "undefined", the setting
- *     is removed entirely, except when used as the member of an array in which
- *     case it becomes null.
- *   - If the environment variable is set to a string representation of a finite
- *     number, the string is converted to that number.
- *   - If the environment variable is set to any other string, including the
- *     empty string, the value is that string.
- *   - If the environment variable is unset and a default value is provided, the
- *     value is as if the environment variable was set to the provided default:
- *       - "${UNSET_VAR:}" becomes the empty string.
- *       - "${UNSET_VAR:foo}" becomes the string "foo".
- *       - "${UNSET_VAR:true}" and "${UNSET_VAR:false}" become true and false.
- *       - "${UNSET_VAR:null}" becomes null.
- *       - "${UNSET_VAR:undefined}" causes the setting to be removed (or be set
- *         to null, if used as a member of an array).
- *   - If the environment variable is unset and no default value is provided,
- *     the value becomes null. THIS BEHAVIOR MAY CHANGE IN A FUTURE VERSION OF
- *     ETHERPAD; if you want the default value to be null, you should explicitly
- *     specify "null" as the default value.
- *
- * EXAMPLE:
- *    "port":     "${PORT:9001}"
- *    "minify":   "${MINIFY}"
- *    "skinName": "${SKIN_NAME:colibris}"
- *
- * Would read the configuration values for those items from the environment
- * variables PORT, MINIFY and SKIN_NAME.
- *
- * If PORT and SKIN_NAME variables were not defined, the default values 9001 and
- * "colibris" would be used.
- * The configuration value "minify", on the other hand, does not have a
- * designated default value. Thus, if the environment variable MINIFY were
- * undefined, "minify" would be null.
- *
- * REMARKS:
- * 1) please note that variable substitution always needs to be quoted.
- *
- *    "port":     9001,            <-- Literal values. When not using
- *    "minify":   false                substitution, only strings must be
- *    "skinName": "colibris"           quoted. Booleans and numbers must not.
- *
- *    "port":     "${PORT:9001}"   <-- CORRECT: if you want to use a variable
- *    "minify":   "${MINIFY:true}"     substitution, put quotes around its name,
- *    "skinName": "${SKIN_NAME}"       even if the required value is a number or
- *                                     a boolean.
- *                                     Etherpad will take care of rewriting it
- *                                     to the proper type if necessary.
- *
- *    "port":     ${PORT:9001}     <-- ERROR: this is not valid json. Quotes
- *    "minify":   ${MINIFY}            around variable names are missing.
- *    "skinName": ${SKIN_NAME}
- *
- * 2) Beware of undefined variables and default values: nulls and empty strings
- *    are different!
- *
- *    This is particularly important for user's passwords (see the relevant
- *    section):
- *
- *    "password": "${PASSW}"  // if PASSW is not defined would result in password === null
- *    "password": "${PASSW:}" // if PASSW is not defined would result in password === ''
- *
- *    If you want to use an empty value (null) as default value for a variable,
- *    simply do not set it, without putting any colons: "${ABIWORD}".
- *
- * 3) if you want to use newlines in the default value of a string parameter,
- *    use "\n" as usual.
- *
- *    "defaultPadText" : "${DEFAULT_PAD_TEXT}Line 1\nLine 2"
- */
-{
-  /*
-   * Name your instance!
-   */
-  "title": "${TITLE:Etherpad}",
-
-  /*
-   * Pathname of the favicon you want to use. If null, the skin's favicon is
-   * used if one is provided by the skin, otherwise the default Etherpad favicon
-   * is used. If this is a relative path it is interpreted as relative to the
-   * Etherpad root directory.
-   */
-  "favicon": "${FAVICON:null}",
-
-  /*
-   * Skin name.
-   *
-   * Its value has to be an existing directory under src/static/skins.
-   * You can write your own, or use one of the included ones:
-   *
-   * - "no-skin":  an empty skin (default). This yields the unmodified,
-   *               traditional Etherpad theme.
-   * - "colibris": the new experimental skin (since Etherpad 1.8), candidate to
-   *               become the default in Etherpad 2.0
-   */
-  "skinName": "${SKIN_NAME:colibris}",
-
-  /*
-   * Skin Variants
-   *
-   * Use the UI skin variants builder at /p/test#skinvariantsbuilder
-   *
-   * For the colibris skin only, you can choose how to render the three main
-   * containers:
-   * - toolbar (top menu with icons)
-   * - editor (containing the text of the pad)
-   * - background (area outside of editor, mostly visible when using page style)
-   *
-   * For each of the 3 containers you can choose 4 color combinations:
-   * super-light, light, dark, super-dark.
-   *
-   * For example, to make the toolbar dark, you will include "dark-toolbar" into
-   * skinVariants.
-   *
-   * You can provide multiple skin variants separated by spaces. Default
-   * skinVariant is "super-light-toolbar super-light-editor light-background".
-   *
-   * For the editor container, you can also make it full width by adding
-   * "full-width-editor" variant (by default editor is rendered as a page, with
-   * a max-width of 900px).
-   */
-  "skinVariants": "${SKIN_VARIANTS:super-light-toolbar super-light-editor light-background}",
-
-  /*
-   * IP and port which Etherpad should bind at.
-   *
-   * Binding to a Unix socket is also supported: just use an empty string for
-   * the ip, and put the full path to the socket in the port parameter.
-   *
-   * EXAMPLE USING UNIX SOCKET:
-   *    "ip": "",                             // <-- has to be an empty string
-   *    "port" : "/somepath/etherpad.socket", // <-- path to a Unix socket
-   */
-  "ip": "${IP:0.0.0.0}",
-  "port": "${PORT:9001}",
-
-  /*
-   * Option to hide/show the settings.json in admin page.
-   *
-   * Default option is set to true
-   */
-  "showSettingsInAdminPage": "${SHOW_SETTINGS_IN_ADMIN_PAGE:true}",
-
-  /*
-   * Node native SSL support
-   *
-   * This is disabled by default.
-   * Make sure to have the minimum and correct file access permissions set so
-   * that the Etherpad server can access them
-   */
-
-  /*
-  "ssl" : {
-            "key"  : "/path-to-your/epl-server.key",
-            "cert" : "/path-to-your/epl-server.crt",
-            "ca": ["/path-to-your/epl-intermediate-cert1.crt", "/path-to-your/epl-intermediate-cert2.crt"]
-          },
-  */
-
-  /*
-   * The type of the database.
-   *
-   * You can choose between many DB drivers, for example: dirty, postgres,
-   * sqlite, mysql.
-   *
-   * You shouldn't use "dirty" for for anything else than testing or
-   * development.
-   *
-   *
-   * Database specific settings are dependent on dbType, and go in dbSettings.
-   * Remember that since Etherpad 1.6.0 you can also store this information in
-   * credentials.json.
-   *
-   * For a complete list of the supported drivers, please refer to:
-   * https://www.npmjs.com/package/ueberdb2
-   */
-
-  "dbType": "${DB_TYPE:dirty}",
-  "dbSettings": {
-    "host":       "${DB_HOST:undefined}",
-    "port":       "${DB_PORT:undefined}",
-    "database":   "${DB_NAME:undefined}",
-    "user":       "${DB_USER:undefined}",
-    "password":   "${DB_PASS:undefined}",
-    "charset":    "${DB_CHARSET:undefined}",
-    "filename":   "${DB_FILENAME:var/dirty.db}",
-    "collection": "${DB_COLLECTION:undefined}",
-    "url":        "${DB_URL:undefined}"
-  },
-
-  /*
-   * The default text of a pad
-   */
-  "defaultPadText" : "${DEFAULT_PAD_TEXT:Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at https:\/\/etherpad.org\n}",
-
-  /*
-   * Default Pad behavior.
-   *
-   * Change them if you want to override.
-   */
-  "padOptions": {
-    "noColors":         "${PAD_OPTIONS_NO_COLORS:false}",
-    "showControls":     "${PAD_OPTIONS_SHOW_CONTROLS:true}",
-    "showChat":         "${PAD_OPTIONS_SHOW_CHAT:true}",
-    "showLineNumbers":  "${PAD_OPTIONS_SHOW_LINE_NUMBERS:true}",
-    "useMonospaceFont": "${PAD_OPTIONS_USE_MONOSPACE_FONT:false}",
-    "userName":         "${PAD_OPTIONS_USER_NAME:null}",
-    "userColor":        "${PAD_OPTIONS_USER_COLOR:null}",
-    "rtl":              "${PAD_OPTIONS_RTL:false}",
-    "alwaysShowChat":   "${PAD_OPTIONS_ALWAYS_SHOW_CHAT:false}",
-    "chatAndUsers":     "${PAD_OPTIONS_CHAT_AND_USERS:false}",
-    "lang":             "${PAD_OPTIONS_LANG:null}"
-  },
-
-  /*
-   * Pad Shortcut Keys
-   */
-  "padShortcutEnabled" : {
-    "altF9":     "${PAD_SHORTCUTS_ENABLED_ALT_F9:true}",      /* focus on the File Menu and/or editbar */
-    "altC":      "${PAD_SHORTCUTS_ENABLED_ALT_C:true}",       /* focus on the Chat window */
-    "cmdShift2": "${PAD_SHORTCUTS_ENABLED_CMD_SHIFT_2:true}", /* shows a gritter popup showing a line author */
-    "delete":    "${PAD_SHORTCUTS_ENABLED_DELETE:true}",
-    "return":    "${PAD_SHORTCUTS_ENABLED_RETURN:true}",
-    "esc":       "${PAD_SHORTCUTS_ENABLED_ESC:true}",         /* in mozilla versions 14-19 avoid reconnecting pad */
-    "cmdS":      "${PAD_SHORTCUTS_ENABLED_CMD_S:true}",       /* save a revision */
-    "tab":       "${PAD_SHORTCUTS_ENABLED_TAB:true}",         /* indent */
-    "cmdZ":      "${PAD_SHORTCUTS_ENABLED_CMD_Z:true}",       /* undo/redo */
-    "cmdY":      "${PAD_SHORTCUTS_ENABLED_CMD_Y:true}",       /* redo */
-    "cmdI":      "${PAD_SHORTCUTS_ENABLED_CMD_I:true}",       /* italic */
-    "cmdB":      "${PAD_SHORTCUTS_ENABLED_CMD_B:true}",       /* bold */
-    "cmdU":      "${PAD_SHORTCUTS_ENABLED_CMD_U:true}",       /* underline */
-    "cmd5":      "${PAD_SHORTCUTS_ENABLED_CMD_5:true}",       /* strike through */
-    "cmdShiftL": "${PAD_SHORTCUTS_ENABLED_CMD_SHIFT_L:true}", /* unordered list */
-    "cmdShiftN": "${PAD_SHORTCUTS_ENABLED_CMD_SHIFT_N:true}", /* ordered list */
-    "cmdShift1": "${PAD_SHORTCUTS_ENABLED_CMD_SHIFT_1:true}", /* ordered list */
-    "cmdShiftC": "${PAD_SHORTCUTS_ENABLED_CMD_SHIFT_C:true}", /* clear authorship */
-    "cmdH":      "${PAD_SHORTCUTS_ENABLED_CMD_H:true}",       /* backspace */
-    "ctrlHome":  "${PAD_SHORTCUTS_ENABLED_CTRL_HOME:true}",   /* scroll to top of pad */
-    "pageUp":    "${PAD_SHORTCUTS_ENABLED_PAGE_UP:true}",
-    "pageDown":  "${PAD_SHORTCUTS_ENABLED_PAGE_DOWN:true}"
-  },
-
-  /*
-   * Should we suppress errors from being visible in the default Pad Text?
-   */
-  "suppressErrorsInPadText": "${SUPPRESS_ERRORS_IN_PAD_TEXT:false}",
-
-  /*
-   * If this option is enabled, a user must have a session to access pads.
-   * This effectively allows only group pads to be accessed.
-   */
-  "requireSession": "${REQUIRE_SESSION:false}",
-
-  /*
-   * Users may edit pads but not create new ones.
-   *
-   * Pad creation is only via the API.
-   * This applies both to group pads and regular pads.
-   */
-  "editOnly": "${EDIT_ONLY:false}",
-
-  /*
-   * If true, all css & js will be minified before sending to the client.
-   *
-   * This will improve the loading performance massively, but makes it difficult
-   * to debug the javascript/css
-   */
-  "minify": "${MINIFY:true}",
-
-  /*
-   * How long may clients use served javascript code (in seconds)?
-   *
-   * Not setting this may cause problems during deployment.
-   * Set to 0 to disable caching.
-   */
-  "maxAge": "${MAX_AGE:21600}", // 60 * 60 * 6 = 6 hours
-
-  /*
-   * Absolute path to the Abiword executable.
-   *
-   * Abiword is needed to get advanced import/export features of pads. Setting
-   * it to null disables Abiword and will only allow plain text and HTML
-   * import/exports.
-   */
-  "abiword": "${ABIWORD:null}",
-
-  /*
-   * This is the absolute path to the soffice executable.
-   *
-   * LibreOffice can be used in lieu of Abiword to export pads.
-   * Setting it to null disables LibreOffice exporting.
-   */
-  "soffice": "${SOFFICE:null}",
-
-  /*
-   * Path to the Tidy executable.
-   *
-   * Tidy is used to improve the quality of exported pads.
-   * Setting it to null disables Tidy.
-   */
-  "tidyHtml": "${TIDY_HTML:null}",
-
-  /*
-   * Allow import of file types other than the supported ones:
-   * txt, doc, docx, rtf, odt, html & htm
-   */
-  "allowUnknownFileEnds": "${ALLOW_UNKNOWN_FILE_ENDS:true}",
-
-  /*
-   * This setting is used if you require authentication of all users.
-   *
-   * Note: "/admin" always requires authentication.
-   */
-  "requireAuthentication": "${REQUIRE_AUTHENTICATION:false}",
-
-  /*
-   * Require authorization by a module, or a user with is_admin set, see below.
-   */
-  "requireAuthorization": "${REQUIRE_AUTHORIZATION:false}",
-
-  /*
-   * When you use NGINX or another proxy/load-balancer set this to true.
-   *
-   * This is especially necessary when the reverse proxy performs SSL
-   * termination, otherwise the cookies will not have the "secure" flag.
-   *
-   * The other effect will be that the logs will contain the real client's IP,
-   * instead of the reverse proxy's IP.
-   */
-  "trustProxy": "${TRUST_PROXY:false}",
-
-  /*
-   * Settings controlling the session cookie issued by Etherpad.
-   */
-  "cookie": {
-    /*
-     * How often (in milliseconds) the key used to sign the express_sid cookie
-     * should be rotated. Long rotation intervals reduce signature verification
-     * overhead (because there are fewer historical keys to check) and database
-     * load (fewer historical keys to store, and less frequent queries to
-     * get/update the keys). Short rotation intervals are slightly more secure.
-     *
-     * Multiple Etherpad processes sharing the same database (table) is
-     * supported as long as the clock sync error is significantly less than this
-     * value.
-     *
-     * Key rotation can be disabled (not recommended) by setting this to 0 or
-     * null, or by disabling session expiration (see sessionLifetime).
-     */
-    // 86400000 = 1d * 24h/d * 60m/h * 60s/m * 1000ms/s
-    "keyRotationInterval": "${COOKIE_KEY_ROTATION_INTERVAL:86400000}",
-
-    /*
-     * Value of the SameSite cookie property. "Lax" is recommended unless
-     * Etherpad will be embedded in an iframe from another site, in which case
-     * this must be set to "None". Note: "None" will not work (the browser will
-     * not send the cookie to Etherpad) unless https is used to access Etherpad
-     * (either directly or via a reverse proxy with "trustProxy" set to true).
-     *
-     * "Strict" is not recommended because it has few security benefits but
-     * significant usability drawbacks vs. "Lax". See
-     * https://stackoverflow.com/q/41841880 for discussion.
-     */
-    "sameSite": "${COOKIE_SAME_SITE:Lax}",
-
-    /*
-     * How long (in milliseconds) after navigating away from Etherpad before the
-     * user is required to log in again. (The express_sid cookie is set to
-     * expire at time now + sessionLifetime when first created, and its
-     * expiration time is periodically refreshed to a new now + sessionLifetime
-     * value.) If requireAuthentication is false then this value does not really
-     * matter.
-     *
-     * The "best" value depends on your users' usage patterns and the amount of
-     * convenience you desire. A long lifetime is more convenient (users won't
-     * have to log back in as often) but has some drawbacks:
-     *   - It increases the amount of state kept in the database.
-     *   - It might weaken security somewhat: The cookie expiration is refreshed
-     *     indefinitely without consulting authentication or authorization
-     *     hooks, so once a user has accessed a pad, the user can continue to
-     *     use the pad until the user leaves for longer than sessionLifetime.
-     *   - More historical keys (sessionLifetime / keyRotationInterval) must be
-     *     checked when verifying signatures.
-     *
-     * Session lifetime can be set to infinity (not recommended) by setting this
-     * to null or 0. Note that if the session does not expire, most browsers
-     * will delete the cookie when the browser exits, but a session record is
-     * kept in the database forever.
-     */
-    // 864000000 = 10d * 24h/d * 60m/h * 60s/m * 1000ms/s
-    "sessionLifetime": "${COOKIE_SESSION_LIFETIME:864000000}",
-
-    /*
-     * How long (in milliseconds) before the expiration time of an active user's
-     * session is refreshed (to now + sessionLifetime). This setting affects the
-     * following:
-     *   - How often a new session expiration time will be written to the
-     *     database.
-     *   - How often each user's browser will ping the Etherpad server to
-     *     refresh the expiration time of the session cookie.
-     *
-     * High values reduce the load on the database and the load from browsers,
-     * but can shorten the effective session lifetime if Etherpad is restarted
-     * or the user navigates away.
-     *
-     * Automatic session refreshes can be disabled (not recommended) by setting
-     * this to null.
-     */
-    // 86400000 = 1d * 24h/d * 60m/h * 60s/m * 1000ms/s
-    "sessionRefreshInterval": "${COOKIE_SESSION_REFRESH_INTERVAL:86400000}"
-  },
-
-  /*
-   * Privacy: disable IP logging
-   */
-  "disableIPlogging": "${DISABLE_IP_LOGGING:false}",
-
-  /*
-   * Time (in seconds) to automatically reconnect pad when a "Force reconnect"
-   * message is shown to user.
-   *
-   * Set to 0 to disable automatic reconnection.
-   */
-  "automaticReconnectionTimeout": "${AUTOMATIC_RECONNECTION_TIMEOUT:0}",
-
-  /*
-   * By default, when caret is moved out of viewport, it scrolls the minimum
-   * height needed to make this line visible.
-   */
-  "scrollWhenFocusLineIsOutOfViewport": {
-
-    /*
-     * Percentage of viewport height to be additionally scrolled.
-     *
-     * E.g.: use "percentage.editionAboveViewport": 0.5, to place caret line in
-     *       the middle of viewport, when user edits a line above of the
-     *       viewport
-     *
-     * Set to 0 to disable extra scrolling
-     */
-    "percentage": {
-      "editionAboveViewport": "${FOCUS_LINE_PERCENTAGE_ABOVE:0}",
-      "editionBelowViewport": "${FOCUS_LINE_PERCENTAGE_BELOW:0}"
-    },
-
-    /*
-     * Time (in milliseconds) used to animate the scroll transition.
-     * Set to 0 to disable animation
-     */
-    "duration": "${FOCUS_LINE_DURATION:0}",
-
-    /*
-     * Flag to control if it should scroll when user places the caret in the
-     * last line of the viewport
-     */
-    "scrollWhenCaretIsInTheLastLineOfViewport": "${FOCUS_LINE_CARET_SCROLL:false}",
-
-    /*
-     * Percentage of viewport height to be additionally scrolled when user
-     * presses arrow up in the line of the top of the viewport.
-     *
-     * Set to 0 to let the scroll to be handled as default by Etherpad
-     */
-    "percentageToScrollWhenUserPressesArrowUp": "${FOCUS_LINE_PERCENTAGE_ARROW_UP:0}"
-  },
-
-  /*
-   * User accounts. These accounts are used by:
-   *   - default HTTP basic authentication if no plugin handles authentication
-   *   - some but not all authentication plugins
-   *   - some but not all authorization plugins
-   *
-   * User properties:
-   *   - password: The user's password. Some authentication plugins will ignore
-   *     this.
-   *   - is_admin: true gives access to /admin. Defaults to false. If you do not
-   *     uncomment this, /admin will not be available!
-   *   - readOnly: If true, this user will not be able to create new pads or
-   *     modify existing pads. Defaults to false.
-   *   - canCreate: If this is true and readOnly is false, this user can create
-   *     new pads. Defaults to true.
-   *
-   * Authentication and authorization plugins may define additional properties.
-   *
-   * WARNING: passwords should not be stored in plaintext in this file.
-   *          If you want to mitigate this, please install ep_hash_auth and
-   *          follow the section "secure your installation" in README.md
-   */
-
-  "users": {
-    "admin": {
-      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
-      // 2) please note that if password is null, the user will not be created
-      "password": "${ADMIN_PASSWORD:null}",
-      "is_admin": true
-    },
-    "user": {
-      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
-      // 2) please note that if password is null, the user will not be created
-      "password": "${USER_PASSWORD:null}",
-      "is_admin": false
-    }
-  },
-
-  /*
-   * Restrict socket.io transport methods
-   */
-  "socketTransportProtocols" : ["xhr-polling", "jsonp-polling", "htmlfile"],
-
-  "socketIo": {
-    /*
-     * Maximum permitted client message size (in bytes). All messages from
-     * clients that are larger than this will be rejected. Large values make it
-     * possible to paste large amounts of text, and plugins may require a larger
-     * value to work properly, but increasing the value increases susceptibility
-     * to denial of service attacks (malicious clients can exhaust memory).
-     */
-    "maxHttpBufferSize": "${SOCKETIO_MAX_HTTP_BUFFER_SIZE:10000}"
-  },
-
-  /*
-   * Allow Load Testing tools to hit the Etherpad Instance.
-   *
-   * WARNING: this will disable security on the instance.
-   */
-  "loadTest": "${LOAD_TEST:false}",
-
-  /**
-  * Disable dump of objects preventing a clean exit
-  */
-  "dumpOnUncleanExit": "${DUMP_ON_UNCLEAN_EXIT:false}",
-
-  /*
-   * Disable indentation on new line when previous line ends with some special
-   * chars (':', '[', '(', '{')
-   */
-
-  /*
-  "indentationOnNewLine": false,
-  */
-
-  /*
-   * From Etherpad 1.8.3 onwards, import and export of pads is always rate
-   * limited.
-   *
-   * The default is to allow at most 10 requests per IP in a 90 seconds window.
-   * After that the import/export request is rejected.
-   *
-   * See https://github.com/nfriedly/express-rate-limit for more options
-   */
-  "importExportRateLimiting": {
-    // duration of the rate limit window (milliseconds)
-    "windowMs": "${IMPORT_EXPORT_RATE_LIMIT_WINDOW:90000}",
-
-    // maximum number of requests per IP to allow during the rate limit window
-    "max": "${IMPORT_EXPORT_MAX_REQ_PER_IP:10}"
-  },
-
-  /*
-   * From Etherpad 1.8.3 onwards, the maximum allowed size for a single imported
-   * file is always bounded.
-   *
-   * File size is specified in bytes. Default is 50 MB.
-   */
-  "importMaxFileSize": "${IMPORT_MAX_FILE_SIZE:52428800}", // 50 * 1024 * 1024
-
-  /*
-   * From Etherpad 1.8.5 onwards, when Etherpad is in production mode commits from individual users are rate limited
-   *
-   * The default is to allow at most 10 changes per IP in a 1 second window.
-   * After that the change is rejected.
-   *
-   * See https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#websocket-single-connection-prevent-flooding for more options
-   */
-  "commitRateLimiting": {
-    // duration of the rate limit window (seconds)
-    "duration": "${COMMIT_RATE_LIMIT_DURATION:1}",
-
-    // maximum number of changes per IP to allow during the rate limit window
-    "points": "${COMMIT_RATE_LIMIT_POINTS:10}"
-  },
-
-  /*
-   * Toolbar buttons configuration.
-   *
-   * Uncomment to customize.
-   */
-
-  /*
-  "toolbar": {
-    "left": [
-      ["bold", "italic", "underline", "strikethrough"],
-      ["orderedlist", "unorderedlist", "indent", "outdent"],
-      ["undo", "redo"],
-      ["clearauthorship"]
-    ],
-    "right": [
-      ["importexport", "timeslider", "savedrevision"],
-      ["settings", "embed"],
-      ["showusers"]
-    ],
-    "timeslider": [
-      ["timeslider_export", "timeslider_returnToPad"]
-    ]
-  },
-  */
-
-  /*
-   * Expose Etherpad version in the web interface and in the Server http header.
-   *
-   * Do not enable on production machines.
-   */
-  "exposeVersion": "${EXPOSE_VERSION:false}",
-
-  /*
-   * The log level we are using.
-   *
-   * Valid values: DEBUG, INFO, WARN, ERROR
-   */
-  "loglevel": "${LOGLEVEL:INFO}",
-
-  /* Override any strings found in locale directories */
-  "customLocaleStrings": {},
-
-  /* Disable Admin UI tests */
-  "enableAdminUITests": false,
-
-  /*
-   * Enable/Disable case-insensitive pad names.
-   */
-  "lowerCasePadIds": "${LOWER_CASE_PAD_IDS:false}"
-}

settings.json.template

@@ -1,662 +1,74 @@
 /*
- * This file must be valid JSON. But comments are allowed
- *
- * Please edit settings.json, not settings.json.template
- *
- * Please note that starting from Etherpad 1.6.0 you can store DB credentials in
- * a separate file (credentials.json).
- *
- *
- * ENVIRONMENT VARIABLE SUBSTITUTION
- * =================================
- *
- * All the configuration values can be read from environment variables using the
- * syntax "${ENV_VAR}" or "${ENV_VAR:default_value}".
- *
- * This is useful, for example, when running in a Docker container.
- *
- * DETAILED RULES:
- *   - If the environment variable is set to the string "true" or "false", the
- *     value becomes Boolean true or false.
- *   - If the environment variable is set to the string "null", the value
- *     becomes null.
- *   - If the environment variable is set to the string "undefined", the setting
- *     is removed entirely, except when used as the member of an array in which
- *     case it becomes null.
- *   - If the environment variable is set to a string representation of a finite
- *     number, the string is converted to that number.
- *   - If the environment variable is set to any other string, including the
- *     empty string, the value is that string.
- *   - If the environment variable is unset and a default value is provided, the
- *     value is as if the environment variable was set to the provided default:
- *       - "${UNSET_VAR:}" becomes the empty string.
- *       - "${UNSET_VAR:foo}" becomes the string "foo".
- *       - "${UNSET_VAR:true}" and "${UNSET_VAR:false}" become true and false.
- *       - "${UNSET_VAR:null}" becomes null.
- *       - "${UNSET_VAR:undefined}" causes the setting to be removed (or be set
- *         to null, if used as a member of an array).
- *   - If the environment variable is unset and no default value is provided,
- *     the value becomes null. THIS BEHAVIOR MAY CHANGE IN A FUTURE VERSION OF
- *     ETHERPAD; if you want the default value to be null, you should explicitly
- *     specify "null" as the default value.
- *
- * EXAMPLE:
- *    "port":     "${PORT:9001}"
- *    "minify":   "${MINIFY}"
- *    "skinName": "${SKIN_NAME:colibris}"
- *
- * Would read the configuration values for those items from the environment
- * variables PORT, MINIFY and SKIN_NAME.
- *
- * If PORT and SKIN_NAME variables were not defined, the default values 9001 and
- * "colibris" would be used.
- * The configuration value "minify", on the other hand, does not have a
- * designated default value. Thus, if the environment variable MINIFY were
- * undefined, "minify" would be null.
- *
- * REMARKS:
- * 1) please note that variable substitution always needs to be quoted.
- *
- *    "port":     9001,            <-- Literal values. When not using
- *    "minify":   false                substitution, only strings must be
- *    "skinName": "colibris"           quoted. Booleans and numbers must not.
- *
- *    "port":     "${PORT:9001}"   <-- CORRECT: if you want to use a variable
- *    "minify":   "${MINIFY:true}"     substitution, put quotes around its name,
- *    "skinName": "${SKIN_NAME}"       even if the required value is a number or
- *                                     a boolean.
- *                                     Etherpad will take care of rewriting it
- *                                     to the proper type if necessary.
- *
- *    "port":     ${PORT:9001}     <-- ERROR: this is not valid json. Quotes
- *    "minify":   ${MINIFY}            around variable names are missing.
- *    "skinName": ${SKIN_NAME}
- *
- * 2) Beware of undefined variables and default values: nulls and empty strings
- *    are different!
- *
- *    This is particularly important for user's passwords (see the relevant
- *    section):
- *
- *    "password": "${PASSW}"  // if PASSW is not defined would result in password === null
- *    "password": "${PASSW:}" // if PASSW is not defined would result in password === ''
- *
- *    If you want to use an empty value (null) as default value for a variable,
- *    simply do not set it, without putting any colons: "${ABIWORD}".
- *
- * 3) if you want to use newlines in the default value of a string parameter,
- *    use "\n" as usual.
- *
- *    "defaultPadText" : "${DEFAULT_PAD_TEXT}Line 1\nLine 2"
- */
+  This file must be valid JSON. But comments are allowed
+
+  Please edit settings.json, not settings.json.template
+*/
 {
-  /*
-   * Name your instance!
-   */
-  "title": "Etherpad",
-
-  /*
-   * Pathname of the favicon you want to use. If null, the skin's favicon is
-   * used if one is provided by the skin, otherwise the default Etherpad favicon
-   * is used. If this is a relative path it is interpreted as relative to the
-   * Etherpad root directory.
-   */
-  "favicon": null,
-
-  /*
-   * Skin name.
-   *
-   * Its value has to be an existing directory under src/static/skins.
-   * You can write your own, or use one of the included ones:
-   *
-   * - "no-skin":  an empty skin (default). This yields the unmodified,
-   *               traditional Etherpad theme.
-   * - "colibris": the new experimental skin (since Etherpad 1.8), candidate to
-   *               become the default in Etherpad 2.0
-   */
-  "skinName": "colibris",
-
-  /*
-   * Skin Variants
-   *
-   * Use the UI skin variants builder at /p/test#skinvariantsbuilder
-   *
-   * For the colibris skin only, you can choose how to render the three main
-   * containers:
-   * - toolbar (top menu with icons)
-   * - editor (containing the text of the pad)
-   * - background (area outside of editor, mostly visible when using page style)
-   *
-   * For each of the 3 containers you can choose 4 color combinations:
-   * super-light, light, dark, super-dark.
-   *
-   * For example, to make the toolbar dark, you will include "dark-toolbar" into
-   * skinVariants.
-   *
-   * You can provide multiple skin variants separated by spaces. Default
-   * skinVariant is "super-light-toolbar super-light-editor light-background".
-   *
-   * For the editor container, you can also make it full width by adding
-   * "full-width-editor" variant (by default editor is rendered as a page, with
-   * a max-width of 900px).
-   */
-  "skinVariants": "super-light-toolbar super-light-editor light-background",
-
-  /*
-   * IP and port which Etherpad should bind at.
-   *
-   * Binding to a Unix socket is also supported: just use an empty string for
-   * the ip, and put the full path to the socket in the port parameter.
-   *
-   * EXAMPLE USING UNIX SOCKET:
-   *    "ip": "",                             // <-- has to be an empty string
-   *    "port" : "/somepath/etherpad.socket", // <-- path to a Unix socket
-   */
+  //Ip and port which etherpad should bind at
   "ip": "0.0.0.0",
-  "port": 9001,
-
-  /*
-   * Option to hide/show the settings.json in admin page.
-   *
-   * Default option is set to true
-   */
-  "showSettingsInAdminPage": true,
-
-  /*
-   * Node native SSL support
-   *
-   * This is disabled by default.
-   * Make sure to have the minimum and correct file access permissions set so
-   * that the Etherpad server can access them
-   */
-
-  /*
-  "ssl" : {
-            "key"  : "/path-to-your/epl-server.key",
-            "cert" : "/path-to-your/epl-server.crt",
-            "ca": ["/path-to-your/epl-intermediate-cert1.crt", "/path-to-your/epl-intermediate-cert2.crt"]
-          },
-  */
-
-  /*
-   * The type of the database.
-   *
-   * You can choose between many DB drivers, for example: dirty, postgres,
-   * sqlite, mysql.
-   *
-   * You shouldn't use "dirty" for for anything else than testing or
-   * development.
-   *
-   *
-   * Database specific settings are dependent on dbType, and go in dbSettings.
-   * Remember that since Etherpad 1.6.0 you can also store this information in
-   * credentials.json.
-   *
-   * For a complete list of the supported drivers, please refer to:
-   * https://www.npmjs.com/package/ueberdb2
-   */
-
-  "dbType": "dirty",
-  "dbSettings": {
-    "filename": "var/dirty.db"
-  },
-
-  /*
-   * An Example of MySQL Configuration (commented out).
-   *
-   * See: https://github.com/ether/etherpad-lite/wiki/How-to-use-Etherpad-Lite-with-MySQL
-   */
-
-  /*
-  "dbType" : "mysql",
+  "port" : 9001,
+  
+  //The Type of the database. You can choose between dirty, postgres, sqlite and mysql
+  //You shouldn't use "dirty" for for anything else than testing or development
+  "dbType" : "dirty",
+  //the database specific settings
   "dbSettings" : {
-    "user":     "etherpaduser",
-    "host":     "localhost",
-    "port":     3306,
-    "password": "PASSWORD",
-    "database": "etherpad_lite_db",
-    "charset":  "utf8mb4"
-  },
+                   "filename" : "var/dirty.db"
+                 },
+                 
+  /* An Example of MySQL Configuration
+   "dbType" : "mysql",
+   "dbSettings" : {
+                    "user"    : "root", 
+                    "host"    : "localhost", 
+                    "password": "", 
+                    "database": "store"
+                  },
   */
+  
+  //the default text of a pad
+  "defaultPadText" : "Welcome to Etherpad Lite!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nEtherpad Lite on Github: http:\/\/j.mp/ep-lite\n",
+  
+  /* Users must have a session to access pads. This effectively allows only group pads to be accessed. */
+  "requireSession" : false,
 
-  /*
-   * The default text of a pad
-   */
-  "defaultPadText" : "Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at https:\/\/etherpad.org\n",
+  /* Users may edit pads but not create new ones. Pad creation is only via the API. This applies both to group pads and regular pads. */
+  "editOnly" : false,
+  
+  /* if true, all css & js will be minified before sending to the client. This will improve the loading performance massivly, 
+     but makes it impossible to debug the javascript/css */
+  "minify" : true,
 
-  /*
-   * Default Pad behavior.
-   *
-   * Change them if you want to override.
-   */
-  "padOptions": {
-    "noColors":         false,
-    "showControls":     true,
-    "showChat":         true,
-    "showLineNumbers":  true,
-    "useMonospaceFont": false,
-    "userName":         null,
-    "userColor":        null,
-    "rtl":              false,
-    "alwaysShowChat":   false,
-    "chatAndUsers":     false,
-    "lang":             null
-  },
-
-  /*
-   * Pad Shortcut Keys
-   */
-  "padShortcutEnabled" : {
-    "altF9":     true, /* focus on the File Menu and/or editbar */
-    "altC":      true, /* focus on the Chat window */
-    "cmdShift2": true, /* shows a gritter popup showing a line author */
-    "delete":    true,
-    "return":    true,
-    "esc":       true, /* in mozilla versions 14-19 avoid reconnecting pad */
-    "cmdS":      true, /* save a revision */
-    "tab":       true, /* indent */
-    "cmdZ":      true, /* undo/redo */
-    "cmdY":      true, /* redo */
-    "cmdI":      true, /* italic */
-    "cmdB":      true, /* bold */
-    "cmdU":      true, /* underline */
-    "cmd5":      true, /* strike through */
-    "cmdShiftL": true, /* unordered list */
-    "cmdShiftN": true, /* ordered list */
-    "cmdShift1": true, /* ordered list */
-    "cmdShiftC": true, /* clear authorship */
-    "cmdH":      true, /* backspace */
-    "ctrlHome":  true, /* scroll to top of pad */
-    "pageUp":    true,
-    "pageDown":  true
-  },
-
-  /*
-   * Should we suppress errors from being visible in the default Pad Text?
-   */
-  "suppressErrorsInPadText": false,
-
-  /*
-   * If this option is enabled, a user must have a session to access pads.
-   * This effectively allows only group pads to be accessed.
-   */
-  "requireSession": false,
-
-  /*
-   * Users may edit pads but not create new ones.
-   *
-   * Pad creation is only via the API.
-   * This applies both to group pads and regular pads.
-   */
-  "editOnly": false,
-
-  /*
-   * If true, all css & js will be minified before sending to the client.
-   *
-   * This will improve the loading performance massively, but makes it difficult
-   * to debug the javascript/css
-   */
-  "minify": true,
-
-  /*
-   * How long may clients use served javascript code (in seconds)?
-   *
-   * Not setting this may cause problems during deployment.
-   * Set to 0 to disable caching.
-   */
-  "maxAge": 21600, // 60 * 60 * 6 = 6 hours
-
-  /*
-   * Absolute path to the Abiword executable.
-   *
-   * Abiword is needed to get advanced import/export features of pads. Setting
-   * it to null disables Abiword and will only allow plain text and HTML
-   * import/exports.
-   */
-  "abiword": null,
-
-  /*
-   * This is the absolute path to the soffice executable.
-   *
-   * LibreOffice can be used in lieu of Abiword to export pads.
-   * Setting it to null disables LibreOffice exporting.
-   */
-  "soffice": null,
-
-  /*
-   * Path to the Tidy executable.
-   *
-   * Tidy is used to improve the quality of exported pads.
-   * Setting it to null disables Tidy.
-   */
-  "tidyHtml": null,
-
-  /*
-   * Allow import of file types other than the supported ones:
-   * txt, doc, docx, rtf, odt, html & htm
-   */
-  "allowUnknownFileEnds": true,
-
-  /*
-   * This setting is used if you require authentication of all users.
-   *
-   * Note: "/admin" always requires authentication.
-   */
+  /* How long may clients use served javascript code (in seconds)? Without versioning this
+     may cause problems during deployment. Set to 0 to disable caching */
+  "maxAge" : 21600, // 60 * 60 * 6 = 6 hours
+  
+  /* This is the path to the Abiword executable. Setting it to null, disables abiword.
+     Abiword is needed to enable the import/export of pads*/  
+  "abiword" : null,
+ 
+  /* This setting is used if you require authentication of all users.
+     Note: /admin always requires authentication. */
   "requireAuthentication": false,
 
-  /*
-   * Require authorization by a module, or a user with is_admin set, see below.
-   */
+  /* Require authorization by a module, or a user with is_admin set, see below. */
   "requireAuthorization": false,
 
-  /*
-   * When you use NGINX or another proxy/load-balancer set this to true.
-   *
-   * This is especially necessary when the reverse proxy performs SSL
-   * termination, otherwise the cookies will not have the "secure" flag.
-   *
-   * The other effect will be that the logs will contain the real client's IP,
-   * instead of the reverse proxy's IP.
-   */
-  "trustProxy": false,
-
-  /*
-   * Settings controlling the session cookie issued by Etherpad.
-   */
-  "cookie": {
-    /*
-     * How often (in milliseconds) the key used to sign the express_sid cookie
-     * should be rotated. Long rotation intervals reduce signature verification
-     * overhead (because there are fewer historical keys to check) and database
-     * load (fewer historical keys to store, and less frequent queries to
-     * get/update the keys). Short rotation intervals are slightly more secure.
-     *
-     * Multiple Etherpad processes sharing the same database (table) is
-     * supported as long as the clock sync error is significantly less than this
-     * value.
-     *
-     * Key rotation can be disabled (not recommended) by setting this to 0 or
-     * null, or by disabling session expiration (see sessionLifetime).
-     */
-    "keyRotationInterval": 86400000, // = 1d * 24h/d * 60m/h * 60s/m * 1000ms/s
-
-    /*
-     * Value of the SameSite cookie property. "Lax" is recommended unless
-     * Etherpad will be embedded in an iframe from another site, in which case
-     * this must be set to "None". Note: "None" will not work (the browser will
-     * not send the cookie to Etherpad) unless https is used to access Etherpad
-     * (either directly or via a reverse proxy with "trustProxy" set to true).
-     *
-     * "Strict" is not recommended because it has few security benefits but
-     * significant usability drawbacks vs. "Lax". See
-     * https://stackoverflow.com/q/41841880 for discussion.
-     */
-    "sameSite": "Lax",
-
-    /*
-     * How long (in milliseconds) after navigating away from Etherpad before the
-     * user is required to log in again. (The express_sid cookie is set to
-     * expire at time now + sessionLifetime when first created, and its
-     * expiration time is periodically refreshed to a new now + sessionLifetime
-     * value.) If requireAuthentication is false then this value does not really
-     * matter.
-     *
-     * The "best" value depends on your users' usage patterns and the amount of
-     * convenience you desire. A long lifetime is more convenient (users won't
-     * have to log back in as often) but has some drawbacks:
-     *   - It increases the amount of state kept in the database.
-     *   - It might weaken security somewhat: The cookie expiration is refreshed
-     *     indefinitely without consulting authentication or authorization
-     *     hooks, so once a user has accessed a pad, the user can continue to
-     *     use the pad until the user leaves for longer than sessionLifetime.
-     *   - More historical keys (sessionLifetime / keyRotationInterval) must be
-     *     checked when verifying signatures.
-     *
-     * Session lifetime can be set to infinity (not recommended) by setting this
-     * to null or 0. Note that if the session does not expire, most browsers
-     * will delete the cookie when the browser exits, but a session record is
-     * kept in the database forever.
-     */
-    "sessionLifetime": 864000000, // = 10d * 24h/d * 60m/h * 60s/m * 1000ms/s
-
-    /*
-     * How long (in milliseconds) before the expiration time of an active user's
-     * session is refreshed (to now + sessionLifetime). This setting affects the
-     * following:
-     *   - How often a new session expiration time will be written to the
-     *     database.
-     *   - How often each user's browser will ping the Etherpad server to
-     *     refresh the expiration time of the session cookie.
-     *
-     * High values reduce the load on the database and the load from browsers,
-     * but can shorten the effective session lifetime if Etherpad is restarted
-     * or the user navigates away.
-     *
-     * Automatic session refreshes can be disabled (not recommended) by setting
-     * this to null.
-     */
-    "sessionRefreshInterval": 86400000 // = 1d * 24h/d * 60m/h * 60s/m * 1000ms/s
-  },
-
-  /*
-   * Privacy: disable IP logging
-   */
-  "disableIPlogging": false,
-
-  /*
-   * Time (in seconds) to automatically reconnect pad when a "Force reconnect"
-   * message is shown to user.
-   *
-   * Set to 0 to disable automatic reconnection.
-   */
-  "automaticReconnectionTimeout": 0,
-
-  /*
-   * By default, when caret is moved out of viewport, it scrolls the minimum
-   * height needed to make this line visible.
-   */
-  "scrollWhenFocusLineIsOutOfViewport": {
-
-    /*
-     * Percentage of viewport height to be additionally scrolled.
-     *
-     * E.g.: use "percentage.editionAboveViewport": 0.5, to place caret line in
-     *       the middle of viewport, when user edits a line above of the
-     *       viewport
-     *
-     * Set to 0 to disable extra scrolling
-     */
-    "percentage": {
-      "editionAboveViewport": 0,
-      "editionBelowViewport": 0
-    },
-
-    /*
-     * Time (in milliseconds) used to animate the scroll transition.
-     * Set to 0 to disable animation
-     */
-    "duration": 0,
-
-    /*
-     * Flag to control if it should scroll when user places the caret in the
-     * last line of the viewport
-     */
-    "scrollWhenCaretIsInTheLastLineOfViewport": false,
-
-    /*
-     * Percentage of viewport height to be additionally scrolled when user
-     * presses arrow up in the line of the top of the viewport.
-     *
-     * Set to 0 to let the scroll to be handled as default by Etherpad
-     */
-    "percentageToScrollWhenUserPressesArrowUp": 0
-  },
-
-  /*
-   * User accounts. These accounts are used by:
-   *   - default HTTP basic authentication if no plugin handles authentication
-   *   - some but not all authentication plugins
-   *   - some but not all authorization plugins
-   *
-   * User properties:
-   *   - password: The user's password. Some authentication plugins will ignore
-   *     this.
-   *   - is_admin: true gives access to /admin. Defaults to false. If you do not
-   *     uncomment this, /admin will not be available!
-   *   - readOnly: If true, this user will not be able to create new pads or
-   *     modify existing pads. Defaults to false.
-   *   - canCreate: If this is true and readOnly is false, this user can create
-   *     new pads. Defaults to true.
-   *
-   * Authentication and authorization plugins may define additional properties.
-   *
-   * WARNING: passwords should not be stored in plaintext in this file.
-   *          If you want to mitigate this, please install ep_hash_auth and
-   *          follow the section "secure your installation" in README.md
-   */
-
+  /* Users for basic authentication. is_admin = true gives access to /admin.
+     If you do not uncomment this, /admin will not be available! */
   /*
   "users": {
     "admin": {
-      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
-      // 2) please note that if password is null, the user will not be created
       "password": "changeme1",
       "is_admin": true
     },
     "user": {
-      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
-      // 2) please note that if password is null, the user will not be created
       "password": "changeme1",
       "is_admin": false
     }
   },
   */
 
-  /*
-   * Restrict socket.io transport methods
-   */
-  "socketTransportProtocols" : ["xhr-polling", "jsonp-polling", "htmlfile"],
-
-  "socketIo": {
-    /*
-     * Maximum permitted client message size (in bytes). All messages from
-     * clients that are larger than this will be rejected. Large values make it
-     * possible to paste large amounts of text, and plugins may require a larger
-     * value to work properly, but increasing the value increases susceptibility
-     * to denial of service attacks (malicious clients can exhaust memory).
-     */
-    "maxHttpBufferSize": 10000
-  },
-
-  /*
-   * Allow Load Testing tools to hit the Etherpad Instance.
-   *
-   * WARNING: this will disable security on the instance.
-   */
-  "loadTest": false,
-
-  /**
-  * Disable dump of objects preventing a clean exit
-  */
-  "dumpOnUncleanExit": false,
-
-  /*
-   * Disable indentation on new line when previous line ends with some special
-   * chars (':', '[', '(', '{')
-   */
-
-  /*
-  "indentationOnNewLine": false,
-  */
-
-  /*
-   * From Etherpad 1.8.3 onwards, import and export of pads is always rate
-   * limited.
-   *
-   * The default is to allow at most 10 requests per IP in a 90 seconds window.
-   * After that the import/export request is rejected.
-   *
-   * See https://github.com/nfriedly/express-rate-limit for more options
-   */
-  "importExportRateLimiting": {
-    // duration of the rate limit window (milliseconds)
-    "windowMs": 90000,
-
-    // maximum number of requests per IP to allow during the rate limit window
-    "max": 10
-  },
-
-  /*
-   * From Etherpad 1.8.3 onwards, the maximum allowed size for a single imported
-   * file is always bounded.
-   *
-   * File size is specified in bytes. Default is 50 MB.
-   */
-  "importMaxFileSize": 52428800, // 50 * 1024 * 1024
-
-  /*
-   * From Etherpad 1.8.5 onwards, when Etherpad is in production mode commits from individual users are rate limited
-   *
-   * The default is to allow at most 10 changes per IP in a 1 second window.
-   * After that the change is rejected.
-   *
-   * See https://github.com/animir/node-rate-limiter-flexible/wiki/Overall-example#websocket-single-connection-prevent-flooding for more options
-   */
-  "commitRateLimiting": {
-    // duration of the rate limit window (seconds)
-    "duration": 1,
-
-    // maximum number of changes per IP to allow during the rate limit window
-    "points": 10
-  },
-
-  /*
-   * Toolbar buttons configuration.
-   *
-   * Uncomment to customize.
-   */
-
-  /*
-  "toolbar": {
-    "left": [
-      ["bold", "italic", "underline", "strikethrough"],
-      ["orderedlist", "unorderedlist", "indent", "outdent"],
-      ["undo", "redo"],
-      ["clearauthorship"]
-    ],
-    "right": [
-      ["importexport", "timeslider", "savedrevision"],
-      ["settings", "embed"],
-      ["showusers"]
-    ],
-    "timeslider": [
-      ["timeslider_export", "timeslider_returnToPad"]
-    ]
-  },
-  */
-
-  /*
-   * Expose Etherpad version in the web interface and in the Server http header.
-   *
-   * Do not enable on production machines.
-   */
-  "exposeVersion": false,
-
-  /*
-   * The log level we are using.
-   *
-   * Valid values: DEBUG, INFO, WARN, ERROR
-   */
-  "loglevel": "INFO",
-
-  /* Override any strings found in locale directories */
-  "customLocaleStrings": {},
-
-  /* Disable Admin UI tests */
-  "enableAdminUITests": false,
-
-  /*
-   * Enable/Disable case-insensitive pad names.
-   */
-  "lowerCasePadIds": false
+  /* The log level we are using, can be: DEBUG, INFO, WARN, ERROR */
+  "loglevel": "INFO"
 }

src/.eslintrc.cjs

@@ -1,141 +0,0 @@
-'use strict';
-
-// This is a workaround for https://github.com/eslint/eslint/issues/3458
-require('eslint-config-etherpad/patch/modern-module-resolution');
-
-module.exports = {
-  ignorePatterns: [
-    '/static/js/admin/jquery.autosize.js',
-    '/static/js/admin/minify.json.js',
-    '/static/js/vendors/browser.js',
-    '/static/js/vendors/farbtastic.js',
-    '/static/js/vendors/gritter.js',
-    '/static/js/vendors/html10n.js',
-    '/static/js/vendors/jquery.js',
-    '/static/js/vendors/nice-select.js',
-    '/tests/frontend/lib/',
-  ],
-  overrides: [
-    {
-      files: [
-        '**/.eslintrc.*',
-      ],
-      extends: 'etherpad/node',
-    },
-    {
-      files: [
-        '**/*',
-      ],
-      excludedFiles: [
-        '**/.eslintrc.*',
-        'tests/frontend/**/*',
-      ],
-      extends: 'etherpad/node',
-    },
-    {
-      files: [
-        'static/**/*',
-        'tests/frontend/helper.js',
-        'tests/frontend/helper/**/*',
-      ],
-      excludedFiles: [
-        '**/.eslintrc.*',
-      ],
-      extends: 'etherpad/browser',
-      env: {
-        'shared-node-browser': true,
-      },
-      overrides: [
-        {
-          files: [
-            'tests/frontend/helper/**/*',
-          ],
-          globals: {
-            helper: 'readonly',
-          },
-        },
-      ],
-    },
-    {
-      files: [
-        'tests/**/*',
-      ],
-      excludedFiles: [
-        '**/.eslintrc.*',
-        'tests/frontend/cypress/**/*',
-        'tests/frontend/helper.js',
-        'tests/frontend/helper/**/*',
-        'tests/frontend/travis/**/*',
-        'tests/ratelimit/**/*',
-      ],
-      extends: 'etherpad/tests',
-      rules: {
-        'mocha/no-exports': 'off',
-        'mocha/no-top-level-hooks': 'off',
-      },
-    },
-    {
-      files: [
-        'tests/backend/**/*',
-      ],
-      excludedFiles: [
-        '**/.eslintrc.*',
-      ],
-      extends: 'etherpad/tests/backend',
-      overrides: [
-        {
-          files: [
-            'tests/backend/**/*',
-          ],
-          excludedFiles: [
-            'tests/backend/specs/**/*',
-          ],
-          rules: {
-            'mocha/no-exports': 'off',
-            'mocha/no-top-level-hooks': 'off',
-          },
-        },
-      ],
-    },
-    {
-      files: [
-        'tests/frontend/**/*',
-      ],
-      excludedFiles: [
-        '**/.eslintrc.*',
-        'tests/frontend/cypress/**/*',
-        'tests/frontend/helper.js',
-        'tests/frontend/helper/**/*',
-        'tests/frontend/travis/**/*',
-      ],
-      extends: 'etherpad/tests/frontend',
-      overrides: [
-        {
-          files: [
-            'tests/frontend/**/*',
-          ],
-          excludedFiles: [
-            'tests/frontend/specs/**/*',
-          ],
-          rules: {
-            'mocha/no-exports': 'off',
-            'mocha/no-top-level-hooks': 'off',
-          },
-        },
-      ],
-    },
-    {
-      files: [
-        'tests/frontend/cypress/**/*',
-      ],
-      extends: 'etherpad/tests/cypress',
-    },
-    {
-      files: [
-        'tests/frontend/travis/**/*',
-      ],
-      extends: 'etherpad/node',
-    },
-  ],
-  root: true,
-};

src/README.md

@@ -1 +0,0 @@
-Ignore this file and see the file in the base installation folder