├── .gitignore
├── client.js
├── .eslintrc.cjs
├── ep.json
├── .github
├── dependabot.yml
└── workflows
│ ├── backend-tests.yml
│ ├── frontend-tests.yml
│ └── npmpublish.yml
├── README.md
├── LICENSE.md
├── package.json
├── templates
└── search.html
├── index.js
├── .travis.yml
└── CONTRIBUTING.md
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | .ep_initialized
3 | .cache.json
4 |
--------------------------------------------------------------------------------
/client.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | const eejs = require('ep_etherpad-lite/node/eejs');
4 |
5 | exports.eejsBlock_indexWrapper = (hookName, args, cb) => {
6 | args.content += eejs.require('ep_search/templates/search.html', {}, module);
7 | return cb();
8 | };
9 |
--------------------------------------------------------------------------------
/.eslintrc.cjs:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | // This is a workaround for https://github.com/eslint/eslint/issues/3458
4 | require('eslint-config-etherpad/patch/modern-module-resolution');
5 |
6 | module.exports = {
7 | root: true,
8 | extends: 'etherpad/plugin',
9 | };
10 |
--------------------------------------------------------------------------------
/ep.json:
--------------------------------------------------------------------------------
1 | {
2 | "parts":[
3 | {
4 | "name": "ep_search",
5 | "hooks": {
6 | "expressCreateServer" : "ep_search/index:registerRoute",
7 | "eejsBlock_indexWrapper": "ep_search/client"
8 | },
9 | "client_hooks": {
10 | }
11 | }
12 | ]
13 | }
14 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 | - package-ecosystem: "github-actions"
4 | directory: "/"
5 | schedule:
6 | interval: "daily"
7 | - package-ecosystem: "npm"
8 | directory: "/"
9 | schedule:
10 | interval: "daily"
11 | versioning-strategy: "increase"
12 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |  
2 |
3 | # Description
4 | A very crude search function
5 |
6 | DO NOT USE THIS IN PRODUCTION
7 |
8 | # TODO
9 | * Add functionality
10 |
11 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Copyright 2020 John McLear
2 |
3 |
4 | Licensed under the Apache License, Version 2.0 (the "License");
5 | you may not use this file except in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 | http://www.apache.org/licenses/LICENSE-2.0
9 |
10 | Unless required by applicable law or agreed to in writing, software
11 | distributed under the License is distributed on an "AS IS" BASIS,
12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | See the License for the specific language governing permissions and
14 | limitations under the License.
15 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "ep_search",
3 | "description": "Search through all pads for a string",
4 | "version": "0.0.22",
5 | "author": {
6 | "name": "John McLear",
7 | "email": "john@mclear.co.uk",
8 | "url": "http://mclear.co.uk"
9 | },
10 | "contributors": [],
11 | "dependencies": {},
12 | "engines": {
13 | "node": ">=12.17.0"
14 | },
15 | "funding": {
16 | "type": "individual",
17 | "url": "https://etherpad.org/"
18 | },
19 | "devDependencies": {
20 | "eslint": "^8.11.0",
21 | "eslint-config-etherpad": "^3.0.9",
22 | "typescript": "^4.5.5"
23 | },
24 | "scripts": {
25 | "lint": "eslint .",
26 | "lint:fix": "eslint --fix ."
27 | },
28 | "peerDependencies": {
29 | "ep_etherpad-lite": ">=1.8.6"
30 | },
31 | "repository": {
32 | "type": "git",
33 | "url": "https://github.com/ether/ep_search.git"
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/templates/search.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
8 |
9 |
10 |
30 |
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | // Main job is to check pads periodically for activity and notify owners
4 | // when someone begins editing and when someone finishes.
5 | const db = require('ep_etherpad-lite/node/db/DB').db;
6 | const async = require('ep_etherpad-lite/node_modules/async');
7 |
8 | // Settings -- EDIT THESE IN settings.json not here..
9 | // var pluginSettings = settings.ep_search;
10 | // var checkFrequency = pluginSettings.checkFrequency || 60000; // 10 seconds
11 |
12 | exports.registerRoute = (hookName, args, cb) => {
13 | args.app.get('/search', (req, res) => {
14 | const searchString = req.query.query;
15 | const result = {};
16 |
17 | db.findKeys('pad:*', '*:*:*', (err, pads) => { // get all pads
18 | async.forEachSeries(pads, (pad, callback) => {
19 | db.get(pad, (err, padData) => { // get the pad contents
20 | const padText = padData.atext.text || '';
21 | // does searchString exist in aText?
22 | if (padText.toLowerCase().indexOf(searchString.toLowerCase()) !== -1) {
23 | result.pad = pad;
24 | }
25 | callback();
26 | });
27 | }, (err) => {
28 | res.send(JSON.stringify(result));
29 | });
30 | });
31 | });
32 | cb(null);
33 | };
34 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: node_js
2 |
3 | node_js:
4 | - "lts/*"
5 |
6 | cache: false
7 |
8 | services:
9 | - docker
10 |
11 | install:
12 | - "export GIT_HASH=$(git rev-parse --verify --short HEAD)"
13 |
14 | #script:
15 | # - "tests/frontend/travis/runner.sh"
16 |
17 | env:
18 | global:
19 | - secure: "WMGxFkOeTTlhWB+ChMucRtIqVmMbwzYdNHuHQjKCcj8HBEPdZLfCuK/kf4rG\nVLcLQiIsyllqzNhBGVHG1nyqWr0/LTm8JRqSCDDVIhpyzp9KpCJQQJG2Uwjk\n6/HIJJh/wbxsEdLNV2crYU/EiVO3A4Bq0YTHUlbhUqG3mSCr5Ec="
20 | - secure: "gejXUAHYscbR6Bodw35XexpToqWkv2ifeECsbeEmjaLkYzXmUUNWJGknKSu7\nEUsSfQV8w+hxApr1Z+jNqk9aX3K1I4btL3cwk2trnNI8XRAvu1c1Iv60eerI\nkE82Rsd5lwUaMEh+/HoL8ztFCZamVndoNgX7HWp5J/NRZZMmh4g="
21 |
22 | jobs:
23 | include:
24 | - name: "Lint test package-lock"
25 | install:
26 | - "npm install lockfile-lint"
27 | script:
28 | - npx lockfile-lint --path package-lock.json --validate-https --allowed-hosts npm
29 | - name: "Run the Backend tests"
30 | before_install:
31 | - sudo add-apt-repository -y ppa:libreoffice/ppa
32 | - sudo apt-get update
33 | - sudo apt-get -y install libreoffice
34 | - sudo apt-get -y install libreoffice-pdfimport
35 | install:
36 | - "npm install"
37 | - "mkdir ep_search"
38 | - "mv !(ep_search) ep_search"
39 | - "git clone https://github.com/ether/etherpad-lite.git etherpad"
40 | - "cd etherpad"
41 | - "mkdir -p node_modules"
42 | - "mv ../ep_search node_modules"
43 | - "bin/installDeps.sh"
44 | - "export GIT_HASH=$(git rev-parse --verify --short HEAD)"
45 | - "cd src && npm install && cd -"
46 | script:
47 | - "tests/frontend/travis/runnerBackend.sh"
48 | - name: "Test the Frontend"
49 | before_script:
50 | - "tests/frontend/travis/sauce_tunnel.sh"
51 | install:
52 | - "npm install"
53 | - "mkdir ep_search"
54 | - "mv !(ep_search) ep_search"
55 | - "git clone https://github.com/ether/etherpad-lite.git etherpad"
56 | - "cd etherpad"
57 | - "mkdir -p node_modules"
58 | - "mv ../ep_search node_modules"
59 | - "bin/installDeps.sh"
60 | - "export GIT_HASH=$(git rev-parse --verify --short HEAD)"
61 | script:
62 | - "tests/frontend/travis/runner.sh"
63 |
64 | notifications:
65 | irc:
66 | channels:
67 | - "irc.freenode.org#etherpad-lite-dev"
68 |
69 | ##ETHERPAD_TRAVIS_V=9
70 | ## Travis configuration automatically created using bin/plugins/updateAllPluginsScript.sh
71 |
--------------------------------------------------------------------------------
/.github/workflows/backend-tests.yml:
--------------------------------------------------------------------------------
1 | name: "Backend tests"
2 |
3 | # any branch is useful for testing before a PR is submitted
4 | on: [push, pull_request]
5 |
6 | jobs:
7 | withplugins:
8 | # run on pushes to any branch
9 | # run on PRs from external forks
10 | if: |
11 | (github.event_name != 'pull_request')
12 | || (github.event.pull_request.head.repo.id != github.event.pull_request.base.repo.id)
13 | name: with Plugins
14 | runs-on: ubuntu-latest
15 |
16 | steps:
17 | -
18 | name: Install libreoffice
19 | run: |
20 | sudo add-apt-repository -y ppa:libreoffice/ppa
21 | sudo apt update
22 | sudo apt install -y --no-install-recommends libreoffice libreoffice-pdfimport
23 | -
24 | name: Install etherpad core
25 | uses: actions/checkout@v3
26 | with:
27 | repository: ether/etherpad-lite
28 | -
29 | name: Checkout plugin repository
30 | uses: actions/checkout@v3
31 | with:
32 | path: ./node_modules/__tmp
33 | -
34 | name: Determine plugin name
35 | id: plugin_name
36 | run: |
37 | cd ./node_modules/__tmp
38 | npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
39 | -
40 | name: Rename plugin directory
41 | run: |
42 | mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
43 | env:
44 | PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
45 | -
46 | uses: actions/setup-node@v3
47 | with:
48 | node-version: 12
49 | cache: 'npm'
50 | cache-dependency-path: |
51 | src/package-lock.json
52 | src/bin/doc/package-lock.json
53 | node_modules/${{ steps.plugin_name.outputs.plugin_name }}/package-lock.json
54 | -
55 | name: Install plugin dependencies
56 | run: |
57 | cd ./node_modules/"${PLUGIN_NAME}"
58 | npm ci
59 | env:
60 | PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
61 | # Etherpad core dependencies must be installed after installing the
62 | # plugin's dependencies, otherwise npm will try to hoist common
63 | # dependencies by removing them from src/node_modules and installing them
64 | # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
65 | # to be buggy, because it sometimes removes dependencies from
66 | # src/node_modules but fails to add them to the top-level node_modules.
67 | # Even if npm correctly hoists the dependencies, the hoisting seems to
68 | # confuse tools such as `npm outdated`, `npm update`, and some ESLint
69 | # rules.
70 | -
71 | name: Install Etherpad core dependencies
72 | run: src/bin/installDeps.sh
73 | -
74 | name: Run the backend tests
75 | run: cd src && npm test
76 |
--------------------------------------------------------------------------------
/.github/workflows/frontend-tests.yml:
--------------------------------------------------------------------------------
1 | # Publicly credit Sauce Labs because they generously support open source
2 | # projects.
3 | name: "frontend tests powered by Sauce Labs"
4 |
5 | on: [push]
6 |
7 | jobs:
8 | test:
9 | runs-on: ubuntu-latest
10 |
11 | steps:
12 | -
13 | name: Fail if Dependabot
14 | if: github.actor == 'dependabot[bot]'
15 | run: |
16 | cat <&2
17 | Frontend tests skipped because Dependabot can't access secrets.
18 | Manually re-run the jobs to run the frontend tests.
19 | For more information, see:
20 | https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/
21 | EOF
22 | exit 1
23 | -
24 | name: Generate Sauce Labs strings
25 | id: sauce_strings
26 | run: |
27 | printf %s\\n '::set-output name=name::${{github.event.repository.name}} ${{ github.workflow }} - ${{ github.job }}'
28 | printf %s\\n '::set-output name=tunnel_id::${{ github.run_id }}-${{ github.run_number }}-${{ github.job }}'
29 | -
30 | name: Check out Etherpad core
31 | uses: actions/checkout@v3
32 | with:
33 | repository: ether/etherpad-lite
34 | -
35 | uses: actions/setup-node@v3
36 | with:
37 | node-version: 12
38 | cache: 'npm'
39 | cache-dependency-path: |
40 | src/package-lock.json
41 | src/bin/doc/package-lock.json
42 | -
43 | name: Check out the plugin
44 | uses: actions/checkout@v3
45 | with:
46 | path: ./node_modules/__tmp
47 | -
48 | name: export GIT_HASH to env
49 | id: environment
50 | run: |
51 | cd ./node_modules/__tmp
52 | echo "::set-output name=sha_short::$(git rev-parse --short ${{ github.sha }})"
53 | -
54 | name: Determine plugin name
55 | id: plugin_name
56 | run: |
57 | cd ./node_modules/__tmp
58 | npx -c 'printf %s\\n "::set-output name=plugin_name::${npm_package_name}"'
59 | -
60 | name: Rename plugin directory
61 | env:
62 | PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
63 | run: |
64 | mv ./node_modules/__tmp ./node_modules/"${PLUGIN_NAME}"
65 | -
66 | name: Install plugin dependencies
67 | env:
68 | PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
69 | run: |
70 | cd ./node_modules/"${PLUGIN_NAME}"
71 | npm ci
72 | # Etherpad core dependencies must be installed after installing the
73 | # plugin's dependencies, otherwise npm will try to hoist common
74 | # dependencies by removing them from src/node_modules and installing them
75 | # in the top-level node_modules. As of v6.14.10, npm's hoist logic appears
76 | # to be buggy, because it sometimes removes dependencies from
77 | # src/node_modules but fails to add them to the top-level node_modules.
78 | # Even if npm correctly hoists the dependencies, the hoisting seems to
79 | # confuse tools such as `npm outdated`, `npm update`, and some ESLint
80 | # rules.
81 | -
82 | name: Install Etherpad core dependencies
83 | run: src/bin/installDeps.sh
84 | -
85 | name: Create settings.json
86 | run: cp settings.json.template settings.json
87 | -
88 | name: Disable import/export rate limiting
89 | run: |
90 | sed -e '/^ *"importExportRateLimiting":/,/^ *\}/ s/"max":.*/"max": 0/' -i settings.json
91 | -
92 | name: Remove standard frontend test files
93 | run: rm -rf src/tests/frontend/specs
94 | -
95 | uses: saucelabs/sauce-connect-action@v2.1.1
96 | with:
97 | username: ${{ secrets.SAUCE_USERNAME }}
98 | accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
99 | tunnelIdentifier: ${{ steps.sauce_strings.outputs.tunnel_id }}
100 | -
101 | name: Run the frontend tests
102 | shell: bash
103 | env:
104 | SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
105 | SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
106 | SAUCE_NAME: ${{ steps.sauce_strings.outputs.name }}
107 | TRAVIS_JOB_NUMBER: ${{ steps.sauce_strings.outputs.tunnel_id }}
108 | GIT_HASH: ${{ steps.environment.outputs.sha_short }}
109 | run: |
110 | src/tests/frontend/travis/runner.sh
111 |
--------------------------------------------------------------------------------
/.github/workflows/npmpublish.yml:
--------------------------------------------------------------------------------
1 | # This workflow will run tests using node and then publish a package to the npm registry when a release is created
2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
3 |
4 | name: Node.js Package
5 |
6 | on:
7 | pull_request:
8 | push:
9 | branches:
10 | - main
11 | - master
12 |
13 | jobs:
14 | test:
15 | runs-on: ubuntu-latest
16 | steps:
17 | # Clone ether/etherpad-lite to ../etherpad-lite so that ep_etherpad-lite
18 | # can be "installed" in this plugin's node_modules. The checkout v2 action
19 | # doesn't support cloning outside of $GITHUB_WORKSPACE (see
20 | # https://github.com/actions/checkout/issues/197), so the repo is first
21 | # cloned to etherpad-lite then moved to ../etherpad-lite. To avoid
22 | # conflicts with this plugin's clone, etherpad-lite must be cloned and
23 | # moved out before this plugin's repo is cloned to $GITHUB_WORKSPACE.
24 | -
25 | uses: actions/checkout@v3
26 | with:
27 | repository: ether/etherpad-lite
28 | path: etherpad-lite
29 | -
30 | run: mv etherpad-lite ..
31 | # etherpad-lite has been moved outside of $GITHUB_WORKSPACE, so it is now
32 | # safe to clone this plugin's repo to $GITHUB_WORKSPACE.
33 | -
34 | uses: actions/checkout@v3
35 | # This is necessary for actions/setup-node because '..' can't be used in
36 | # cache-dependency-path.
37 | -
38 | name: Create ep_etherpad-lite symlink
39 | run: |
40 | mkdir -p node_modules
41 | ln -s ../../etherpad-lite/src node_modules/ep_etherpad-lite
42 | -
43 | uses: actions/setup-node@v3
44 | with:
45 | node-version: 12
46 | cache: 'npm'
47 | cache-dependency-path: |
48 | node_modules/ep_etherpad-lite/package-lock.json
49 | node_modules/ep_etherpad-lite/bin/doc/package-lock.json
50 | package-lock.json
51 | # All of ep_etherpad-lite's devDependencies are installed because the
52 | # plugin might do `require('ep_etherpad-lite/node_modules/${devDep}')`.
53 | # Eventually it would be nice to create an ESLint plugin that prohibits
54 | # Etherpad plugins from piggybacking off of ep_etherpad-lite's
55 | # devDependencies. If we had that, we could change this line to only
56 | # install production dependencies.
57 | -
58 | run: cd ../etherpad-lite/src && npm ci
59 | -
60 | run: npm ci
61 | # This runs some sanity checks and creates a symlink at
62 | # node_modules/ep_etherpad-lite that points to ../../etherpad-lite/src.
63 | # This step must be done after `npm ci` installs the plugin's dependencies
64 | # because npm "helpfully" cleans up such symlinks. :( Installing
65 | # ep_etherpad-lite in the plugin's node_modules prevents lint errors and
66 | # unit test failures if the plugin does `require('ep_etherpad-lite/foo')`.
67 | -
68 | run: npm install --no-save ep_etherpad-lite@file:../etherpad-lite/src
69 | -
70 | run: npm test
71 | -
72 | run: npm run lint
73 |
74 | publish-npm:
75 | if: github.event_name == 'push'
76 | needs: test
77 | runs-on: ubuntu-latest
78 | steps:
79 | -
80 | uses: actions/checkout@v3
81 | with:
82 | fetch-depth: 0
83 | -
84 | uses: actions/setup-node@v3
85 | with:
86 | node-version: 12
87 | registry-url: https://registry.npmjs.org/
88 | cache: 'npm'
89 | -
90 | name: Bump version (patch)
91 | run: |
92 | LATEST_TAG=$(git describe --tags --abbrev=0) || exit 1
93 | NEW_COMMITS=$(git rev-list --count "${LATEST_TAG}"..) || exit 1
94 | [ "${NEW_COMMITS}" -gt 0 ] || exit 0
95 | git config user.name 'github-actions[bot]'
96 | git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
97 | npm ci
98 | npm version patch
99 | git push --follow-tags
100 | # This is required if the package has a prepare script that uses something
101 | # in dependencies or devDependencies.
102 | -
103 | run: npm ci
104 | # `npm publish` must come after `git push` otherwise there is a race
105 | # condition: If two PRs are merged back-to-back then master/main will be
106 | # updated with the commits from the second PR before the first PR's
107 | # workflow has a chance to push the commit generated by `npm version
108 | # patch`. This causes the first PR's `git push` step to fail after the
109 | # package has already been published, which in turn will cause all future
110 | # workflow runs to fail because they will all attempt to use the same
111 | # already-used version number. By running `npm publish` after `git push`,
112 | # back-to-back merges will cause the first merge's workflow to fail but
113 | # the second's will succeed.
114 | -
115 | run: npm publish
116 | env:
117 | NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
118 | -
119 | name: Add package to etherpad organization
120 | run: npm access grant read-write etherpad:developers
121 | env:
122 | NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
123 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributor Guidelines
2 | (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))
3 |
4 | ## Pull requests
5 |
6 | * 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
7 | * PRs should be issued against the **develop** branch: we never pull directly into **master**
8 | * PRs **should not have conflicts** with develop. If there are, please resolve them rebasing and force-pushing
9 | * when preparing your PR, please make sure that you have included the relevant **changes to the documentation** (preferably with usage examples)
10 | * contain meaningful and detailed **commit messages** in the form:
11 | ```
12 | submodule: description
13 |
14 | longer description of the change you have made, eventually mentioning the
15 | number of the issue that is being fixed, in the form: Fixes #someIssueNumber
16 | ```
17 | * if the PR is a **bug fix**:
18 | * the first commit in the series must be a test that shows the failure
19 | * subsequent commits will fix the bug and make the test pass
20 | * the final commit message should include the text `Fixes: #xxx` to link it to its bug report
21 | * 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**
22 | * if you want to remove a feature, **deprecate it instead**:
23 | * write an issue with your deprecation plan
24 | * output a `WARN` in the log informing that the feature is going to be removed
25 | * remove the feature in the next version
26 | * if you want to add a new feature, put it under a **feature flag**:
27 | * once the new feature has reached a minimal level of stability, do a PR for it, so it can be integrated early
28 | * expose a mechanism for enabling/disabling the feature
29 | * 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
30 | * 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
31 |
32 | ## How to write a bug report
33 |
34 | * Please be polite, we all are humans and problems can occur.
35 | * Please add as much information as possible, for example
36 | * client os(s) and version(s)
37 | * browser(s) and version(s), is the problem reproducible on different clients
38 | * special environments like firewalls or antivirus
39 | * host os and version
40 | * npm and nodejs version
41 | * Logfiles if available
42 | * steps to reproduce
43 | * what you expected to happen
44 | * what actually happened
45 | * Please format logfiles and code examples with markdown see github Markdown help below the issue textarea for more information.
46 |
47 | If you send logfiles, please set the loglevel switch DEBUG in your settings.json file:
48 |
49 | ```
50 | /* The log level we are using, can be: DEBUG, INFO, WARN, ERROR */
51 | "loglevel": "DEBUG",
52 | ```
53 |
54 | The logfile location is defined in startup script or the log is directly shown in the commandline after you have started etherpad.
55 |
56 | ## General goals of Etherpad
57 | To make sure everybody is going in the same direction:
58 | * easy to install for admins and easy to use for people
59 | * easy to integrate into other apps, but also usable as standalone
60 | * lightweight and scalable
61 | * extensible, as much functionality should be extendable with plugins so changes don't have to be done in core.
62 | Also, keep it maintainable. We don't wanna end up as the monster Etherpad was!
63 |
64 | ## How to work with git?
65 | * Don't work in your master branch.
66 | * 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)
67 | * Don't use the online edit function of github (this only creates ugly and not working commits!)
68 | * Try to make clean commits that are easy readable (including descriptive commit messages!)
69 | * Test before you push. Sounds easy, it isn't!
70 | * Don't check in stuff that gets generated during build or runtime
71 | * Make small pull requests that are easy to review but make sure they do add value by themselves / individually
72 |
73 | ## Coding style
74 | * 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!)
75 | * Never ever use tabs
76 | * Indentation: JS/CSS: 2 spaces; HTML: 4 spaces
77 | * 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!
78 | * Do generalize sooner or later! (if an old solution, quickly hacked together, poses more problems than it solves today, refactor it!)
79 | * 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!
80 | * If you do make changes, document them! (see below)
81 | * Use protocol independent urls "//"
82 |
83 | ## Branching model / git workflow
84 | see git flow http://nvie.com/posts/a-successful-git-branching-model/
85 |
86 | ### `master` branch
87 | * the stable
88 | * This is the branch everyone should use for production stuff
89 |
90 | ### `develop`branch
91 | * everything that is READY to go into master at some point in time
92 | * This stuff is tested and ready to go out
93 |
94 | ### release branches
95 | * stuff that should go into master very soon
96 | * only bugfixes go into these (see http://nvie.com/posts/a-successful-git-branching-model/ for why)
97 | * 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.
98 |
99 | ### hotfix branches
100 | * fixes for bugs in master
101 |
102 | ### feature branches (in your own repos)
103 | * these are the branches where you develop your features in
104 | * If it's ready to go out, it will be merged into develop
105 |
106 | 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
107 |
108 | ## Documentation
109 | The docs are in the `doc/` folder in the git repository, so people can easily find the suitable docs for the current git revision.
110 |
111 | 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.
112 |
113 | 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.
114 |
115 | ## Testing
116 | Front-end tests are found in the `tests/frontend/` folder in the repository. Run them by pointing your browser to `/tests/frontend`.
117 |
118 | Back-end tests can be run from the `src` directory, via `npm test`.
119 |
120 | ## Things you can help with
121 | 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
122 | * Triage bugs (applying labels) and confirming their existence
123 | * Testing fixes (simply applying them and seeing if it fixes your issue or not) - Some git experience required
124 | * Notifying large site admins of new releases
125 | * Writing Changelogs for releases
126 | * Creating Windows packages
127 | * Creating releases
128 | * Bumping dependencies periodically and checking they don't break anything
129 | * Write proposals for grants
130 | * Co-Author and Publish CVEs
131 | * Work with SFC to maintain legal side of project
132 | * Maintain TODO page - https://github.com/ether/etherpad-lite/wiki/TODO#IMPORTANT_TODOS
133 |
134 |
--------------------------------------------------------------------------------