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

124 commits

Author SHA1 Message Date
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
John McLear
77c805a2bf Merge branch 'master' of github.com:ether/etherpad-lite into develop 2014-11-15 16:01:03 +00:00
John McLear
3ebcaad31f Update README.md 2014-11-01 12:36:57 +00:00
talexand
69b17f5088 changed link wording for readme plugin reference 2014-10-28 15:13:05 -10:00
Trevor Alexander
9a01f905eb Added explicit reference to plugins and themes in readme 2014-10-28 13:07:02 -10:00
Marek Šuppa
72a328cf11 readme: Add formatting sugar for readibility 
* Added a bit more formatting for UNIX-like systems dependencies installation.
 2014-09-23 16:04:22 +02:00
Stefan
c3a6a2374c Update README.md 
Added support for node v0.11 in the installation description
 2014-03-31 02:05:52 +02:00
Marcel Klehr
53bcbfcc07 Don't link to windows build from README 
better link to the website...
 2013-11-18 14:25:47 +01:00
Marcel Klehr
76bd25ac21 Merge branch 'release/1.2.12' 
Conflicts:
	README.md
 2013-10-12 20:38:51 +02:00
maixithn
0630b3e93a Update README.md 
delete double wordings
 2013-10-02 14:00:48 +02:00
Eric Schrijver
b34224559d ‘Etherpad Lite’ -> ‘Etherpad’ 2013-09-29 13:57:37 +02:00
John McLear
1aa5981ce3 Update README.md 2013-09-02 13:56:17 +01:00
John McLear
4ceb2c2e86 Update README.md 2013-07-01 19:54:51 +01:00
John McLear
d5a3d9d03b Update README.md 2013-07-01 19:54:09 +01:00
John McLear
306c4047ea Fix broken git guide link 2013-06-23 16:09:08 +02:00