Commit graph

138 commits

Author SHA1 Message Date
John McLear
b51c85e458
tests: Use the correct Travis shield URI 2020-06-04 23:24:01 +01:00
Sebastian Castro
11f88a9b36 Update Readme with new screenshots
closes #2140
closes #3779
2020-04-19 18:05:59 +02:00
Sebastian Castro
8956efc4ae bin: add fastRun.sh script for developers
Useful for developers, or users that know what they are doing. If you just
upgraded Etherpad version, installed a new dependency, or are simply unsure of
what to do, then before running this script, please execute bin/installDeps.sh
once.

Fixes #3711 (partially)
2020-04-17 18:36:24 +02:00
mathieu.brunot
c3ed04f4ae README.md: Add Travis-CI badge to README
Signed-off-by: mathieu.brunot <mathieu.brunot@monogramm.io>

📝 Add Travis-CI badge to README

Signed-off-by: mathieu.brunot <mathieu.brunot@monogramm.io>
2020-04-13 11:41:02 +02:00
muxator
684f374ece runtime: require node >= 10.13.0 LTS
At the moment, NodeJS 10.x is the lowest supported LTS version. NodeJS 8.x is no
longer supported upstream.

Implements #3835.
Planned in #3650.
2020-04-09 04:43:37 +02:00
Viljami Kuosmanen
e821bbcad8 openapi: add documentation, small optimisation 2020-04-03 01:03:11 +02:00
John McLear
b74a4819ae
beta.etherpad.org been down a while
Sorry about the direct commit 🍡
2020-03-31 19:54:46 +01:00
John McLear
74fa47e295
Pretty sure you need elevated command prompt in windows..
To do anything nowadays.
2020-02-14 23:36:13 +00:00
IRobL
5e44a94d2a Adds a badge/ link to the dockerhub path where this image is published 2019-12-05 21:09:37 +01:00
muxator
c008ee36bd docker: incorporate the docker docs into the official documentation
This also means increasing the indentation level.
2019-11-08 23:17:34 +01:00
muxator
283100db6b runtime: deprecate node 8.x. Require node >= 10.13.0 starting from Etherpad 1.8.3
Nodejs 8 will be EOLed on December 31th, 2019 (https://github.com/nodejs/Release).

This means any future Etherpad version released from 2020 on should require at
least the next LTS (10.13.0). Let's keep some margin and decide that the first
Etherpad version dropping node 8 compatibility will be 1.8.3.

Closes #3650.
2019-10-20 00:02:00 +02:00
muxator
1dd2004f1b security: since there is no dedicated security group, I take charge for now.
Disclosure of vulnerabilities should be handled by a dedicated, multi-person
group, which for now does not exist. I take charge (hopefully temporarily) of
being that point of contact for now.
2019-10-20 00:49:46 +02:00
muxator
decfdb6abe readme: language revision. Removed stale info.
Tried to simplify the document, to reduce unneded info, and to use a less
informal language.

For example, the introductory links describing git made sense 10 years ago.
Today they are not needed to understand what Etherpad is.
And mercurial was always better than git, anyways :)

The mailing list and the IRC channel seem pretty dead by now. Let's just
move everything to Github issues, which was the de facto situation anyways.

About the donation links: I am the maintainer, and I do not know the identity of
the owners of the donation links, so it is correct to remove them. The same was
done on the website three months ago:
https://github.com/ether/ether.github.com/commit/d4ef04605da5
2019-10-20 00:40:18 +02:00
muxator
705cc6f5e4 Change everywhere the link to https://etherpad.org (it was plain http) 2019-04-16 00:54:54 +02:00
muxator
2955740a6e Settings.js: support syntax for default values
+---------------------------+---------------+------------------+
| Configuration string in   | Value of      | Resulting confi- |
| settings.json             | ENV_VAR       | guration value   |
|---------------------------|---------------|------------------|
| "${ENV_VAR}"              | "some_string" | "some_string"    |
| "${ENV_VAR}"              | "9001"        | 9001             |
| "${ENV_VAR}"              | undefined     | null             |
| "${ENV_VAR:some_default}" | "some_string" | "some_string"    |
| "${ENV_VAR:some_default}" | undefined     | "some_default"   |
+---------------------------+---------------+------------------+

Mention this briefly in the main README.md, also.

Closes #3578.
2019-03-21 23:32:08 +01:00
muxator
9d35d15ae3 node8: require nodejs >= 8.9.0, npm >= 6.4
Next version will be Etherpad 1.8. As planned in #3424, we are going to require
NodeJS >=8.9.0 and npm >= 6.4.

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

Closes #3557
2019-02-19 22:01:12 +01:00
muxator
25da955161 README.md: on install, explicitly instruct to clone the "master" branch
The install instructions relied on the default branch being "master" on Github.
This has no longer been the case for some time now.

Let's be explicit, and directly advise new users to put themselves on the stable
branch ("master").
2019-01-25 23:05:05 +01:00
HairyFotr
fce55df2b7 Fix typos 2019-01-16 11:14:04 +01:00
muxator
49449453c9 README: a lot of packages mentioned in the readme are not really needed, simplify
libssl-dev, gzip, python, gcc have never been really needed for Etherpad itself.
They were probably needed back in the day to manually compile nodejs.
2018-12-01 14:16:39 +01:00
muxator
1f927f3e28 README: minor rewording 2018-12-01 14:15:40 +01:00
muxator
76007fe7cb README: removed trailing spaces 2018-12-01 14:11:01 +01:00
muxator
9aaa02ec70 installDeps: no need to download jquery at starting time. Remove curl dependency
In installDeps.sh we have a bunch of code (from 2011) that checks for the
existence of jQuery and eventually downloads it, but since 1239ce7f28 (year
2012) jquery is vendorized in /src/static/js/jquery.js.

Also, stop mentioning curl as a dependency in the README.md

Fixes #3494
2018-10-07 18:56:28 +02:00
muxator
10eadba0d6
docs: mention that nodejs >= 8.9 is preferred 2018-08-15 23:43:11 +02:00
muxator
6c6ac40f7b doc: review "Tweak the settings" 2018-08-09 19:42:14 +02:00
Michael Braun
980a5951ea hint to --sessionkey, --apikey and --credentials in README.md 2018-08-09 19:42:14 +02:00
muxator
10f0cb3253 security: suggest installing ep_hash_auth to get rid of plain text passwords
In its current form, Etherpad stores passwords for users in plain text in
settings.json. We should at least mention the opportunity of installing
ep_hash_auth to start tackling this problem.

The advice was added in README.md and in settings.json.template

Fixes #3444
2018-08-09 00:17:15 +02:00
muxator
7544585908 runtime: enforce minimal node version to 6.9.0
Etherpad 1.6.6 does not run on node <= 5 already.
Node 6.9 is the first LTS release in the 6 series, and comes with npm 3.10.8.

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

Updated the docs accordingly.
2018-07-28 23:33:24 +02:00
muxator
f1056bf01a docs: minimal revision 2018-07-27 00:42:13 +02:00
John McLear
ad898b701a
Update README.md 2018-07-09 15:45:46 +01:00
John McLear
98a03b0867
Update README.md 2018-04-06 13:51:08 +01:00
John McLear
f5aed706b7
Update README.md 2018-04-03 19:55:55 +01:00
John McLear
ba732a6b9e
Update README.md 2018-04-03 18:05:26 +01:00
John McLear
09c2c034c4
Continue to make README suck even less.. REALLY! 2018-04-03 12:57:14 +01:00
John McLear
6047c0de09
Make README not suck. 2018-04-03 12:52:34 +01:00
sevu
67a4209df9 use apt instead of apt-get (#3330) 2018-02-28 06:53:13 -03:00
pedro-nonfree
4ae95c4107 documentation now is in doc/ (#3322) 2018-02-08 16:58:27 -02:00
HairyFotr
c7548450c0
Typos and minor fixes in bin, doc, and root 2017-09-14 13:33:27 +02:00
Alexey Pyltsyn
2dc3eb79d2 Fix links to README.md 2017-05-09 08:28:29 +03:00
Thomas Wucher
127009f719 Use HTTPS for images in README.md
This change prevents mixed-content warnings on pages displaying the readme via HTTPS.
2017-04-19 14:36:48 +02:00
tpltnt
6e1bf9dc90 added curl as dependency 2017-01-12 20:50:31 +01:00
Stefan
3ad13eb0df Change description in README for supported node versions 2016-06-08 19:55:22 +02:00
Luke Rogers
881996ef52 Pedantic Space
<3
2015-10-15 14:02:40 +13:00
Zihua Li
beae99415c Change "Javascript" to "JavaScript" 2015-06-03 19:45:08 +08:00
John McLear
33594a7246 Update README.md 2015-04-15 11:52:03 +01:00
Tom Hunkapiller
4385598de6 update node version checking to 0.10+ or io.js 2015-04-08 23:12:12 -05:00
Tom Hunkapiller
63cbab484d express dropped support for node 0.8; update engine requirements 2015-04-08 23:12:11 -05:00
John McLear
8c795b4e8a Merge pull request #2477 from gabrielliwerant/develop-readme-instructions
Add subdirectory installation instructions
2015-03-31 23:21:02 +01:00
JulR43
b9b110c82f Change git-core to git
git-core package is an obsolete transitional package, it was renamed git.
2015-01-28 17:29:16 +00:00
Gabriel Liwerant
b8af62fdef Add subdirectory installation instructions
Out of the box, etherpad-lite does not work correctly if cloned/installed into a subdirectory within an existing project. To do so, a few minor tweaks to the installation process are necessary which are documented here.
2015-01-20 10:53:52 -05:00
Sean Hussey
d0896806d9 Fix typo 2014-12-03 11:43:15 -05:00