Mirror of https://github.com/fraction/oasis.git to build Docker images 🙈

browser css html javascript nodejs p2p scuttlebutt ssb

Go to file

Christian Bundy fb2e042a12 Remove debug output and add comments Problem: The previous code was printing debug output so that I could ensure that my argument checking worked correctly, but we don't want to distribute a binary that echoes back your arguments to you. Solution: Remove the debug output and add lots of comments to document all of my misunderstandings of how the current code works. :~)		2020-02-26 20:40:23 -08:00
.github	Remove references to npm registry publish	2020-02-17 16:40:53 -08:00
contrib	Experiment with common-good module	2020-01-21 16:22:19 -08:00
docs	Merge pull request #247 from christianbundy/add-termux-docs	2020-02-21 11:04:02 -05:00
scripts	Remove debug output and add comments	2020-02-26 20:40:23 -08:00
src	Update SSB-Mentions and remove workaround	2020-02-19 14:38:10 -08:00
.cspell.json	Add Termux install documentation	2020-02-20 15:12:38 -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	Add VSCode files to gitignore	2020-02-17 12:57:38 +01: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	Specify exact Node.js engine support and test it	2020-01-31 10:59:10 -08:00
CHANGELOG.md	2.11.0	2020-01-16 11:58:00 -08:00
LICENSE	Add LICENSE file (for AGPL-3.0)	2020-01-28 17:45:00 -08:00
README.md	Remove references to npm registry publish	2020-02-17 16:40:53 -08:00
package-lock.json	Update SSB-Mentions and remove workaround	2020-02-19 14:38:10 -08:00
package.json	Update SSB-Mentions and remove workaround	2020-02-19 14:38:10 -08:00

README.md

Oasis

Oasis is a free, open-source, peer-to-peer social application that helps you follow friends and discover new ones on Secure Scuttlebutt (SSB).

🦀 Powered by SSB.
You're the center of your own distributed network. Online or offline, SSB works anywhere that you are. Follow the people you want to see and never worry about spam again. Migrate your data to another SSB app any time you want.

🌐 Bring your own browser.
Use your favorite web browser to read and write messages to the people you care about. Oasis runs over HTTP, so you don't need to worry about adding another Electron app to your computer.

🏰 Just HTML and CSS.
No browser JavaScript! Oasis has strict security rules that prevent any JavaScript from running in your browser, which helps us make Oasis accessible and easy to improve.

Usage

Start Oasis from a command-line interface with the oasis command.

$ 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 'settings' 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 stable releases with npm and Node.js current or active LTS release.

npm --global install 'fraction/oasis#semver:*'

For faster updates and less stability, install from GitHub and upgrade often.

npm --global install fraction/oasis

Want more? Check out install.md.

Resources

License

AGPL-3.0