3wordchant
/
oasis
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Mirror of https://github.com/fraction/oasis.git to build Docker images 🙈
509 Commits 18 Branches 98 Tags 7.5 MiB
JavaScript 90.8%
CSS 7%
Go 1%
Shell 0.9%
Dockerfile 0.3%
Go to file
Christian Bundy e92d5adec6 Add document describing blob security model 
Problem: I still haven't found any best practices for how to run HTML on
your domain without any security concerns. I feel reasonably confident
that our current security precautions mitigate any potential attacks,
but I want to be very up-front with any security mitigations that aren't
so common that they're boring and predictable.  Resolves https://github.com/fraction/oasis/issues/5.

Solution: Add a document to describe our current security model and
mitigations so that we can point at it when asking friends to review the
model and ensure we don't have any holes.
 		2020-02-02 14:00:20 -08:00
.github Experiment with common-good module 2020-01-21 16:22:19 -08:00
contrib Experiment with common-good module 2020-01-21 16:22:19 -08:00
docs Add document describing blob security model 2020-02-02 14:00:20 -08:00
scripts Add release script 2019-12-29 13:51:57 -08:00
src Merge branch 'master' of github.com:fraction/oasis into conn-buttons 2020-01-28 10:25:42 -08:00
.cspell.json Add install-systemd-service.js 2020-01-03 21:06:08 -08:00
.dockerignore Add support for running oasis in a docker container 2020-01-01 10:07:41 -05:00
.eslintrc.js Experiment with common-good module 2020-01-21 16:22:19 -08:00
.gitignore Replace yarn.lock with package-lock.json 2020-01-03 15:19:35 -08:00
.huskyrc Fix Travis CI on Windows 2019-09-16 15:50:03 -07:00
.npmignore Add npmignore 2019-10-31 15:25:05 -07:00
.stylelintrc Experiment with common-good module 2020-01-21 16:22:19 -08:00
.travis.yml Make Travis faster by removing double-build 2020-01-23 12:09:59 -08:00
CHANGELOG.md 2.11.0 2020-01-16 11:58:00 -08:00
README.md Merge branch 'master' of github.com:fraction/oasis into conn-buttons 2020-01-28 10:25:42 -08:00
package-lock.json 2.12.0 2020-01-28 12:56:55 -08:00
package.json 2.12.0 2020-01-28 12:56:55 -08:00

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