Skip to content

Latest commit

 

History

History
77 lines (65 loc) · 3.47 KB

README.md

File metadata and controls

77 lines (65 loc) · 3.47 KB
Raw

Welcome to codepad

Actually, this is my first codepad implementation, and we reference it now as ep_codepad. This project is now outdated by another implementation: the new codepad has a demo

ep_codepad archive

Turn etherpad into codepad, a collaborative online development enviroment. http://codepad.etherpad.org

This etherpad-lite plugin merges functionality of a few simple plugins, and adds tons of functionality on its own. Current features:

  • File Tree view, open files into pads and save them, push them to the server filesystem

  • Search in project files, replace all instances file by file

  • Syntaxhighlighting for 92+ popular languages - based on highlight.js

  • Adds themes, properly implemented with css, and a theme generator

  • beutify html/css/javascript code with jsBeutify

  • Syntax-check javascipt with jsHint, and display results

  • Search and replace in pads in a javascript implementation

  • save/commit/push (F2) and run custom commands or scripts

  • It sets some reasonable defaults and customizes buttons

  • Admin interface based on adminpads

  • Can use a hash instead of a password in the users section of settings.json (ep_hash_auth)

  • Authentication username to etherpad-username, and custom colors defined in settings.json

Special URI's:

  • /files[#URI] - filetree
  • /log - logview
  • /v[/folder(s)]/file - quick view-only with syntaxhighlighting
  • /s[/folder(s)]/file - raw static view-only without anything
  • /p[/folder(s)]/file - open pad for editing

Currently the following codepad parameters are supported in etherpad's settings.json:

  • default theme
  • project_path to save files (needs to be writeable by codepad)
  • log_path for displaying logs (parent dir needs execute right)
  • customize the button to open a browser to the project
  • action to perform when pushing files
  • authentication password-hash and the custom colors

The use of authentication and authorization over https is strongly recommended. Unauthorized access to settings.json may expose operating system files, in the name of the user etherpad is run as. Install with npm or git, create your settings.json and restart etherpad after installation.

  "ep_codepad": { 
    "theme": "Cobalt",
    "project_path": "/srv/project",
    "log_path": "/var/log/codepad/log",
    "play_url": "http://project.local",
    "push_action": "cd /srv/project && git add . && git commit -m 2.x"
  },
  "ep_hash_auth": {
    "hash_typ": "sha512",
    "hash_dig": "hex",
    "hash_dir": "/var/codepad/users",
    "hash_ext": "/.hash",
    "hash_adm": true,
    "allow_namechange": "true"
  },
  "users": {
    "Bud": {"hash": "6c98..66d2","is_admin": true, "color": "#ff2222"},
    "Al":  {"hash": "c7r2..b72c","is_admin": true, "color": "#2244ff"}
  },

It is recommended to run codepad on a VE or VM, with its own subdomain. An optional parameter, installation_folder has been added to support etherpad installations in a subfolder-path in the URI, but this feature has not been tested at all. Please refer to issue #6 on https://github.com/LaKing/ep_codepad

Codepad is NOT tested on and not designed for non-linux operating systems, functionality is partially dependant on linux commands and filesystem properties. 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. Patch etherpad-lite/src/node/db/PadManager.js change '{1,50}$/.test(padId);' to '{1,100}$/.test(padId);'