ebrowser.md

   1 ### [Ebrowser](https://github.com/torappinfo/ebrowser): keyboard-friendly minimal suckless web browser
   2 Ebrowser is designed with the philosophy of [Android uweb browser](https://github.com/torappinfo/uweb) ([gitlab](https://gitlab.com/jamesfengcao/uweb)).
   3
   4 - lightweight (less than 20k bytes) without bundled electron.
   5 - much less memory footprint than edge/chrome browser and highly performant.
   6 - keyboard friendly with vim-style keymaps and command line support in address bar.
   7 - [global redirection](https://uweb.surge.sh/en/redirect/index.html#) to bypass censorship.
   8 - user scripts at will. Ex. pressing "tr" to translate the page (need mapkeys.json config).
   9 - customizable.
  10
  11 Note: Usually electron apps are heavyweight as they use browsers for simple things. Ebrowser uses core chromium effectively and very lightweight. Recommend to install electron separately.
  12
  13 #### Installing (for Windows, MacOS and Linux)
  14 ##### Install with prebuilt binaries
  15 You can find prebuilt binaries [here](https://github.com/torappinfo/ebrowser/releases).
  16
  17 ##### Install with nodejs
  18
  19     npm install electron
  20     npm install ebrowser
  21
  22 Run ebrowser
  23
  24     electron ~/node_modules/ebrowser
  25
  26 Later on, you can run "npm install electron" to update electron/chromium or "npm install ebrowser" to update ebrowser independently.
  27
  28 ##### Update app quickly without updating chromium
  29 Pressing "Alt" to show the menu bar and choose "Check for updates" under "Help". OR
  30
  31 Type ":update" in the address bar and press "enter" key to update.
  32
  33 Mirror urls could be used like ":update https://uwebzh.netlify.app/misc/ebrowser". All the mirrors listed on [uweb browser](https://uwebzh.netlify.app/en/readme/index.html) could be used. The update url needs to be changed accordingly to be the folder "misc/ebrowser" under the mirror site root url.
  34
  35 #### Key shortcuts
  36 - CTRL+C: stop loading
  37 - CTRL+G: address bar to show page url
  38 - CTRL+L: focus to address bar
  39 - CTRL+T: new Tab
  40 - CTRL+SHIFT+T: restore closed Tab
  41 - CTRL+TAB: switch to next tab
  42 - CTRL+SHIFT+TAB: switch to previous tab
  43 - CTRL+W: close Tab
  44 - CTRL+<-: go backward
  45 - CTRL+->: go forward
  46 - CTRL+SHIFT+R: enable global redirection ("gredirect.json")
  47 - CTRL+R: disable global redirection
  48 - ESC: remove focus. similar to vi normal mode.
  49 - F1: Help
  50 - F5: page refresh/reload
  51 - F12: devtools
  52
  53 #### Address bar commands
  54 - "/" for find-in-page
  55 - ":" for address bar commands
  56   - ac [bookmark/history path w/o ext] : load ".rec" file for autocomplete.
  57   - b [bookmarkfilename w/o ext] : bookmark current page in file.
  58   - bml [filename w/o extension]: load/execute the javascript file.
  59   - cert : allow invalid certificates w/o arguments, otherwise restore to default.
  60   - clear : the arguments could be
  61     - cache : clear cache
  62     - dns : clear dns cache
  63     - storage: clear site storage data.
  64     - {[options](https://www.electronjs.org/docs/latest/api/session#sescleardataoptions)}
  65   - ext [extension path]: load unpacked Chrome extension.
  66   - gr [gredirect index]: global redirection with corresponding index. Use the first global redirection url if no argument. Disable global redirection with any index out of the range.
  67   - nc/uc : No Cookie forwarding/Use Cookie forwarding with global redirection.
  68   - nh/uh for No/Use url history.
  69   - nj/uj for No/Use external Javascript files.
  70   - nr/ur for No/Use "redirect.json" for domain redirection.
  71   - np : no proxy.
  72   - up [proxyName] : use proxy. privous proxy or the first proxy in proxy.json w/o [proxyName]. ":up" command also disables global and domain redirections, which are not restored by ":np".
  73   - ua [useragentName] : set user agent for future tabs. default user agent w/o arguments.
  74   - update [updateurl] : update the app. updateurl is optional.
  75   - pdf [filename w/o extension] {[options](https://www.electronjs.org/docs/latest/api/web-contents#contentsprinttopdfoptions)} : print to PDF file. All arguments are optional; empty option "{}" to capture long screenshot as vector graphics.
  76 - "!" address bar commands
  77   "!xx ..." evaluates "xx.js" with the whole address bar text as arguments[0].
  78
  79 #### Commands in no-focus mode (this mode is similar to vi Normal mode)
  80 Pressing "ESC" to enter no-focus mode if not sure.
  81 - ":" for address bar commands
  82 - "/" for find-in-page with address bar
  83 - "!" for "!" address bar commands
  84
  85 The other commands are defined in "mapkeys.json", which will map keys to address bar commands.
  86
  87 #### Configuration files
  88 - "config": lines of address bar commands.
  89 - "search.json": search engines as shortcut-queryUrl pairs.
  90 - "default.autoc": predefined strings for address bar auto completion.
  91 - "gredirect.json": global redirection urls as array of urls
  92 - "redirect.json": domain-replacementDomain pairs, default to be applied.
  93 - "mapkeys.json": keys-addressbarCommands pairs. The addressbar commands are multiple lines of address bar command separated by "\n".
  94 - "proxy.json": name-[ProxyConfig](https://www.electronjs.org/docs/latest/api/structures/proxy-config) pairs
  95 - "uas.json" : name-useragent pairs
  96
  97 #### New usages
  98 - Vector designing with web tech to replace Adobe Illustrator/Inkscape.
  99   - Design with web tech.
 100
 101   - Printing to pdf with customized paper size.
 102   - Magnify the pdf paper size to the required size.
 103
 104   OR
 105
 106   - Adjust window width and use addressbar command line ":Pdf {}" to export vector graphics.
 107   - Use imageMagick to convert to any other vector graphics format.
 108
 109 #### License
 110 You can copy or modify the code/program under the terms of the GPL3.0 or later versions.