Mirror of https://github.com/fraction/oasis.git to build Docker images 🙈
d1d221c2ec
Fix help link in readme |
||
---|---|---|
.github | ||
contrib | ||
docs | ||
scripts | ||
src | ||
.cspell.json | ||
.dockerignore | ||
.eslintrc.js | ||
.gitignore | ||
.huskyrc | ||
.npmignore | ||
.stylelintrc | ||
.travis.yml | ||
CHANGELOG.md | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md |
Oasis
Friendly Scuttlebutt interface designed for simplicity and accessibility. This is an experimental client built with HTML, CSS, and Node.js without any front-end JavaScript. The goal is to support basic social messaging schemas with some extra tools for debugging, not to support all known message types.
Usage
$ oasis --help
Usage: oasis [options]
Options:
--version Show version number [boolean]
-h, --help Show help [boolean]
--open Automatically open app in web browser. Use --no-open to disable.
[boolean] [default: true]
--offline Don't try to connect to scuttlebutt peers or pubs. This can be
changed on the 'meta' page while Oasis is running.
[boolean] [default: false]
--host Hostname for web app to listen on [string] [default: "localhost"]
--port Port for web app to listen on [number] [default: 3000]
--debug Use verbose output for debugging [boolean] [default: false]
Installation
Most people should install Oasis with npm.
npm --global install @fraction/oasis@latest
Please make sure that your Node.js version is the current or active LTS release.
Want more? Check out install.md
.
Resources
See Also
License
AGPL-3.0