|
1 |
| -Turn etherpad into codepad - a collaborative open development enviroment. |
2 |
| - |
3 |
| -Status: Beta - ~bugfixes mostly until 1.0.0 - bug reports welcome. |
| 1 | +Turn etherpad into codepad, a collaborative online development enviroment. |
| 2 | +http://codepad.etherpad.org |
4 | 3 |
|
5 | 4 | This etherpad-lite plugin merges functionality of a few simple plugins, and adds tons of functionality on its own.
|
6 | 5 | Current features:
|
7 | 6 |
|
8 |
| -- File Tree view, open files into pads and save them back. |
9 |
| -- Syntaxhighlighting for 92 popular languages - based on highlight.js |
| 7 | +- File Tree view, open files into pads and save them, push them to the server filesystem |
| 8 | +- Search in project files, replace all instances file by file |
| 9 | +- Syntaxhighlighting for 92+ popular languages - based on highlight.js |
10 | 10 | - Adds themes, properly implemented with css, and a theme generator
|
11 | 11 | - beutify html/css/javascript code with jsBeutify
|
12 | 12 | - Syntax-check javascipt with jsHint, and display results
|
13 |
| -- Search and replace in pads, and in the prject tree |
| 13 | +- Search and replace in pads in a javascript implementation |
14 | 14 | - save/commit/push (F2) and run custom commands or scripts
|
15 | 15 |
|
16 | 16 | - It sets some reasonable defaults and customizes buttons
|
17 | 17 | - Admin interface based on adminpads
|
18 | 18 | - Can use a hash instead of a password in the users section of settings.json (ep_hash_auth)
|
19 |
| -- Authentication user name to username, and custom color |
| 19 | +- Authentication username to etherpad-username, and custom colors defined in settings.json |
20 | 20 |
|
21 | 21 | Special URI's:
|
22 | 22 |
|
23 |
| -- /files - filetree |
| 23 | +- /files[#URI] - filetree |
24 | 24 | - /log - logview
|
25 |
| -- /v[/folder]/file - quick view-only with syntaxhighlighting |
26 |
| -- /p[/folder]/file - open pad for editing |
| 25 | +- /v[/folder(s)]/file - quick view-only with syntaxhighlighting |
| 26 | +- /s[/folder(s)]/file - raw static view-only without anything |
| 27 | +- /p[/folder(s)]/file - open pad for editing |
27 | 28 |
|
28 | 29 | Currently the following codepad parameters are supported in etherpad's settings.json:
|
29 | 30 | - default theme
|
30 |
| -- project_path to save files |
| 31 | +- project_path to save files (needs to be writeable by codepad) |
31 | 32 | - log_path for displaying logs (parent dir needs execute right)
|
32 |
| -- button to open a browser to the project |
| 33 | +- customize the button to open a browser to the project |
33 | 34 | - action to perform when pushing files
|
34 |
| -- authentication password-hash, custom colors |
| 35 | +- authentication password-hash and the custom colors |
35 | 36 |
|
36 | 37 | The use of authentication and authorization over https is strongly recommended.
|
37 | 38 | Unauthorized access to settings.json may expose operating system files, in the name of the user etherpad is run as.
|
| 39 | +Install with npm or git, create your settings.json and restart etherpad after installation. |
38 | 40 |
|
39 | 41 | ```
|
40 | 42 | "ep_codepad": {
|
41 | 43 | "theme": "Cobalt",
|
42 | 44 | "project_path": "/srv/project",
|
43 | 45 | "log_path": "/var/log/codepad/log",
|
44 | 46 | "play_url": "http://project.local",
|
45 |
| - "push_action": "cd /srv/project && git add . && git commit -m codepad-auto" |
| 47 | + "push_action": "cd /srv/project && git add . && git commit -m 2.x" |
46 | 48 | },
|
47 | 49 | "ep_hash_auth": {
|
48 | 50 | "hash_typ": "sha512",
|
49 | 51 | "hash_digest": "hex",
|
50 | 52 | "allow_namechange": "true"
|
51 | 53 | },
|
52 | 54 | "users": {
|
53 |
| - "Bob": {"hash": "6c98..66d2","is_admin": true, color: "#ff2222"}, |
54 |
| - "Al": {"hash": "c7r2..b72c","is_admin": true, color: "#2244ff"} |
| 55 | + "Bud": {"hash": "6c98..66d2","is_admin": true, "color": "#ff2222"}, |
| 56 | + "Al": {"hash": "c7r2..b72c","is_admin": true, "color": "#2244ff"} |
55 | 57 | },
|
56 | 58 | ```
|
| 59 | +An optional parameter, installation_folder has been added to support etherpad installations in a subfolder-path in the URI. |
| 60 | + |
| 61 | +Codpad is NOT tested on and not designed for non-linux operating systems, functionality is partially dependant on linux commands and filesystem properties. |
| 62 | +Etherpad / mariadb has limitations on folder/file length - there is a patch to double the allowed 50 characters if you insist on using long path and filenames. |
| 63 | +Edit etherpad-lite/src/node/db/PadManager.js change '{1,50}$/.test(padId);' to '{1,100}$/.test(padId);' |
57 | 64 |
|
58 |
| -Codepad is designed to work together with fedora "srvctl", an LXC container and virtual server farm managment tool. |
59 |
| -https://githubub.com/LaKing/Fedora-scripts |
| 65 | +Error messages from pads might be hard to see with the tree-view on a dark-backgrounded theme. |
60 | 66 |
|
61 |
| -Known issues: |
62 |
| -- while editing, multiline comments in pads don't get highlighted. |
| 67 | +Codepad is designed to work together with fedora srvctl utility, an LXC container and virtual server farm managment tool. It is recommended to run codepad on a VE or VM. |
| 68 | +https://github.com/LaKing/srvctl |
63 | 69 |
|
64 | 70 | Please feel free to send comments, bug-reports, ...
|
65 |
| -.. and/or in case of professional, or commercial use please donate to support open source software developers. |
| 71 | +.. and/or in case of professional, or commercial use please donate to support open source software developers, or hire them. |
0 commit comments