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

browser css html javascript nodejs p2p scuttlebutt ssb

Go to file

Daan Wynen 3a6e484f71 Merge pull request #549 from johanbove/patch-1 Update README.md		2020-12-08 02:20:13 +01:00
.github	Increase dependabot open PR limit	2020-11-21 16:51:26 -08:00
contrib	Refactor Docker example	2020-05-10 13:52:47 -07:00
docs	Merge branch 'master' of github.com:fraction/oasis into add-more-tests	2020-11-22 16:55:37 -08:00
scripts	Remove debug output and add comments	2020-02-26 20:40:23 -08:00
src	Add rebuild button to settings	2020-11-29 10:55:00 -08:00
test	Add more comprehensive tests	2020-11-22 15:35:15 -08:00
.cspell.json	Remove comments to disable linters	2020-11-22 16:52:12 -08:00
.depcheckrc	Fir common-good call	2020-11-25 23:30:04 +01:00
.dockerignore	Refactor Docker example	2020-05-10 13:52:47 -07:00
.gitignore	ignore vim swap files	2020-10-19 10:04:39 +02:00
.huskyrc	Revert "Removes husky to fix #346 "	2020-11-22 21:08:45 +01:00
.mailmap	Add .mailmap for canonical identities	2020-03-24 16:59:20 -07:00
.prettierignore	Add very basic test suite	2020-04-03 09:17:13 -07:00
.stylelintrc	Experiment with common-good module	2020-01-21 16:22:19 -08:00
LICENSE	Add LICENSE file (for AGPL-3.0)	2020-01-28 17:45:00 -08:00
package-lock.json	Bump highlight.js from 10.4.0 to 10.4.1	2020-12-04 05:04:42 +00:00
package.json	Fir common-good call	2020-11-25 23:30:04 +01:00
README.md	Update README.md	2020-12-07 22:05:41 +01: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. Switch to any SSB app you want at any time.

🌐 Bring your own browser.
Use your favorite web browser to read and write messages to the people you care about. Oasis runs a small HTTP server on your own computer, 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.

Example

After installing, launch Oasis from the command line by running:

oasis

It will then pop open a browser window for you.

Use oasis --help to get configuration options. You can change the default values with a custom configuration.

Installation

First, you'll need Node.js and npm on your computer. Run node --version to see if you have it. If not, or if it's older than the current or active LTS version, you should download Node.js first.

Then you can install the stable version of Oasis:

npm -g install fraction/oasis#semver:

Or, for faster updates and less stability, install Oasis from GitHub and upgrade often.

npm -g install fraction/oasis

Check out install.md for more information.

FAQ

Can I use the same profile from multiple computers?

No, this is a limitation of SSB. You'll need to make a separate profile on each device. There is a workaround we'd like to implement which ties your multiple profiles together.

Can I run this at the same time as Patchwork and other SSB apps?

Yes! They will both use the same data and profile. You can either run them one at a time or simultaneously. If you run them at the same time, start Patchwork first, then Oasis.

Details: SSB apps have two parts: a "server" that manages the database (on your own computer), and a user interface that gets things from the server to display. Only one server can run at a time, but multiple apps can use it.

App	Runs its own SSB server	Can use SSB server of another app
Oasis	Yes, unless one is already running	Yes
Patchwork	Yes	No, only uses its own server
Patchbay	Yes	No, only uses its own server
Patchfox	No	Yes, depends on other apps to provide a server

Resources

License

AGPL-3.0