Mirror of https://github.com/fraction/oasis.git to build Docker images 🙈
Go to file
Jonathan Dahan 8ce7d76df7 Create systemd service install script, fix service
This will check if you have have systemd installed,
copy the service file to your user directory,
and instruct the user how to enable it on login.
2020-01-03 15:03:21 -05:00
.github Add GitHub issue and PR templates 2019-09-17 07:45:42 -07:00
contrib Create systemd service install script, fix service 2020-01-03 15:03:21 -05:00
docs Create systemd service install script, fix service 2020-01-03 15:03:21 -05:00
scripts Add release script 2019-12-29 13:51:57 -08:00
src yay for test cases. oops change require path 2020-01-01 14:12:04 -05:00
.cspell.json Change to remove whoami() calls 2019-12-07 17:01:04 -08:00
.dockerignore Add support for running oasis in a docker container 2020-01-01 10:07:41 -05:00
.gitignore Remove Yarn error log 2019-09-30 09:12:55 -07: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 Add stylelint-config-standard for more opinionated CSS 2019-09-25 19:07:38 -07:00
.travis.yml Add Travis CI cache back 2019-09-17 16:11:55 -07:00
CHANGELOG.md Change changelog format to keep verb from commit message 2019-09-24 16:41:17 -07:00
Dockerfile move server by cooler. ready for future refactors 2020-01-01 14:01:28 -05:00
README.md Create systemd service install script, fix service 2020-01-03 15:03:21 -05:00
index.js Change debug output to be more relevant 2019-11-13 11:24:38 -08:00
package.json 2.9.10 2019-12-29 16:01:22 -08:00
yarn.lock Bump dependencies 2019-12-29 15:51:59 -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:
  --help        Show help                                              [boolean]
  --version     Show version number                                    [boolean]
  --open        Automatically open app in web browser  [boolean] [default: true]
  --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

With npm:

npm -g install @fraction/oasis@latest

With yarn:

yarn global add @fraction/oasis@latest

With docker

docker build . -t oasis
docker volume create ssb
docker run --mount source=ssb,target=/root/.ssb -p 3000:3000 --rm oasis

Starting on login

This will install an oasis service for the current user.

bash contrib/install-systemd-service.bash

Resources

See Also

License

AGPL-3.0