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
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
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
705cc6f5e4
Change everywhere the link to https://etherpad.org (it was plain http)
2019-04-16 00:54:54 +02:00
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
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
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
fce55df2b7
Fix typos
2019-01-16 11:14:04 +01:00
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
1f927f3e28
README: minor rewording
2018-12-01 14:15:40 +01:00
76007fe7cb
README: removed trailing spaces
2018-12-01 14:11:01 +01:00
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 1239ce7f28Fixes #3494
2018-10-07 18:56:28 +02:00
10eadba0d6
docs: mention that nodejs >= 8.9 is preferred
2018-08-15 23:43:11 +02:00
6c6ac40f7b
doc: review "Tweak the settings"
2018-08-09 19:42:14 +02:00
980a5951ea
hint to --sessionkey, --apikey and --credentials in README.md
2018-08-09 19:42:14 +02:00
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
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
f1056bf01a
docs: minimal revision
2018-07-27 00:42:13 +02:00
ad898b701a
Update README.md
2018-07-09 15:45:46 +01:00
98a03b0867
Update README.md
2018-04-06 13:51:08 +01:00
f5aed706b7
Update README.md
2018-04-03 19:55:55 +01:00
ba732a6b9e
Update README.md
2018-04-03 18:05:26 +01:00
09c2c034c4
Continue to make README suck even less.. REALLY!
2018-04-03 12:57:14 +01:00
6047c0de09
Make README not suck.
2018-04-03 12:52:34 +01:00
67a4209df9
use apt instead of apt-get ( #3330 )
2018-02-28 06:53:13 -03:00
4ae95c4107
documentation now is in doc/ ( #3322 )
2018-02-08 16:58:27 -02:00
c7548450c0
Typos and minor fixes in bin, doc, and root
2017-09-14 13:33:27 +02:00
2dc3eb79d2
Fix links to README.md
2017-05-09 08:28:29 +03:00
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
6e1bf9dc90
added curl as dependency
2017-01-12 20:50:31 +01:00
3ad13eb0df
Change description in README for supported node versions
2016-06-08 19:55:22 +02:00
881996ef52
Pedantic Space
...
<3
2015-10-15 14:02:40 +13:00
beae99415c
Change "Javascript" to "JavaScript"
2015-06-03 19:45:08 +08:00
33594a7246
Update README.md
2015-04-15 11:52:03 +01:00
4385598de6
update node version checking to 0.10+ or io.js
2015-04-08 23:12:12 -05:00
63cbab484d
express dropped support for node 0.8; update engine requirements
2015-04-08 23:12:11 -05:00
8c795b4e8a
Merge pull request #2477 from gabrielliwerant/develop-readme-instructions
...
Add subdirectory installation instructions
2015-03-31 23:21:02 +01:00
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
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
d0896806d9
Fix typo
2014-12-03 11:43:15 -05:00
77c805a2bf
Merge branch 'master' of github.com:ether/etherpad-lite into develop
2014-11-15 16:01:03 +00:00
3ebcaad31f
Update README.md
2014-11-01 12:36:57 +00:00
69b17f5088
changed link wording for readme plugin reference
2014-10-28 15:13:05 -10:00
9a01f905eb
Added explicit reference to plugins and themes in readme
2014-10-28 13:07:02 -10:00
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
c3a6a2374c
Update README.md
...
Added support for node v0.11 in the installation description
2014-03-31 02:05:52 +02:00
53bcbfcc07
Don't link to windows build from README
...
better link to the website...
2013-11-18 14:25:47 +01:00
76bd25ac21
Merge branch 'release/1.2.12'
...
Conflicts:
README.md
2013-10-12 20:38:51 +02:00
0630b3e93a
Update README.md
...
delete double wordings
2013-10-02 14:00:48 +02:00
b34224559d
‘Etherpad Lite’ -> ‘Etherpad’
2013-09-29 13:57:37 +02:00
1aa5981ce3
Update README.md
2013-09-02 13:56:17 +01:00
4ceb2c2e86
Update README.md
2013-07-01 19:54:51 +01:00
d5a3d9d03b
Update README.md
2013-07-01 19:54:09 +01:00
306c4047ea
Fix broken git guide link
2013-06-23 16:09:08 +02:00
b527c6ead2
Just a missing character
2013-04-18 12:54:09 +03:00
3cdb8131ce
Actually update windows download link
...
Need to remember to do this on release..
2013-04-08 03:43:34 +02:00
5fb5b6c7af
Linux clarity
2013-04-04 18:23:56 +01:00
43f8778241
hrm, maybe this makes sense to a wider audience
2013-04-04 15:35:19 +01:00
a3136d778d
animated image prolly wont work
2013-04-04 01:56:36 +01:00
a677286a40
line breaks 2
2013-04-04 01:24:09 +01:00
2003dd8327
line breaks
2013-04-04 01:22:46 +01:00
4f07f829db
new readme
2013-04-04 01:20:46 +01:00
782c512e93
Drop support for node v0.6, officially
2013-04-01 14:07:38 +02:00
b084cf4f28
Update README.md
2013-03-17 21:57:14 +01:00
813583c9ce
Update link to dev guidelines
2013-02-20 21:38:24 +01:00
abadfb7b6a
Update README.md
2013-02-18 15:12:37 +00:00
b30e1de3e5
Update README.md
2013-02-18 15:12:11 +00:00
c3972bcb87
Update README.md
2013-02-13 20:14:15 +00:00
1607af8753
Bitcoin yo.
2013-02-13 20:12:46 +00:00
7d2c31d863
fix module links in README.md
2013-01-15 21:16:19 +00:00
a65c7e1b6a
fixed 'client implementations'-link in README.md
2013-01-07 16:25:43 +01:00
1a4923ef60
Update docs
2012-12-23 18:17:30 +01:00
110620696e
Update README.md
2012-12-05 16:00:06 +00:00
2c268f6c48
Fix the path of run.sh on README.md
...
In Linux forward slash is used for file path and not backslash
2012-11-15 22:11:48 +01:00
8b50f194a3
fix README to use ether/
2012-11-14 19:26:37 +00:00
dff8910966
Fix links in README
2012-11-14 20:05:58 +01:00
97d82fd19f
Update README.md
2012-11-14 19:00:40 +00:00
01727d1542
fix typo in Linux install instructions
2012-11-07 23:31:24 -05:00
9bb2bef50d
Improve and reorganize the README
2012-09-10 14:44:06 +02:00
e23da5127b
No longer need bin/installDeps.sh
2012-05-30 23:59:06 +02:00
8619cd5784
Update README.md
2012-03-10 17:23:05 +11:00
b148a42946
Update README.md
2012-02-29 13:45:42 +00:00
43e72da0b9
I suck at md.
2012-02-26 14:24:21 +00:00
59b414c826
Update README.md
2012-02-26 14:23:59 +00:00
45d0d93d03
Update README.md
2012-02-26 14:23:07 +00:00
af40ea3181
added paypal donation point...
2012-02-26 14:22:32 +00:00
979cfdf738
Added foundation flattr account.
2012-02-26 14:20:50 +00:00
6467a1a40f
Document the -s|--settings cli option in README
2012-02-21 15:36:05 -05:00
b15b7fe4bd
Changing openssl dev package name for Fedora to what it actually is.
2012-01-24 18:52:09 -06:00
04d48e8592
Added a getting started developing Etherpad Lite video to readme.md..
2012-01-22 16:29:51 +00:00
ca68196c32
Added a getting started developing Etherpad Lite video to readme.md
2012-01-22 16:24:06 +00:00
7720c312ca
README: add notice about jshint
2012-01-22 21:57:44 +08:00
16e4fa9959
fixed numbers in orderd list
2011-12-04 20:11:31 +01:00
3c8ee3df20
removed docs created with doc.md, these docs were completly useless
2011-12-04 17:12:27 +01:00
73de872bc9
Latest version of node (0.6.3+) has npm baked-in
2011-11-29 17:39:19 -06:00
673d2c028b
Merge branch 'master' of github.com:Pita/etherpad-lite
2011-11-18 13:56:30 -08:00
38742d12b9
Improved the README
2011-11-18 13:56:26 -08:00
7362992191
Update README.md and settings.json.template: use mysql or sqlite for production
2011-11-18 03:49:00 +01:00
46d85a1247
added "build-essential" to list of Ubuntu package dependencies for installing.
2011-09-23 13:20:05 -05:00
0523ffe3bd
Improved the README
2011-08-23 17:56:54 +01:00
muxator