Mirror of https://github.com/fraction/oasis.git to build Docker images 🙈
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
3wc ca67841f2e Update Drone config 1 year ago
.github Increase dependabot open PR limit 2 years ago
contrib Refactor Docker example 3 years ago
docs Fix Docker port mapping 2 years ago
scripts Remove debug output and add comments 3 years ago
src Merge branch 'master' of https://github.com/fraction/oasis into subscribed-channels 2 years ago
test Add more comprehensive tests 2 years ago
.cspell.json Remove comments to disable linters 2 years ago
.depcheckrc Fir common-good call 2 years ago
.dockerignore Refactor Docker example 3 years ago
.drone.yml Update Drone config 1 year ago
.gitignore ignore vim swap files 2 years ago
.huskyrc Revert "Removes husky to fix #346" 2 years ago
.mailmap Add .mailmap for canonical identities 3 years ago
.prettierignore Add very basic test suite 3 years ago
.stylelintrc Experiment with common-good module 3 years ago
LICENSE Add LICENSE file (for AGPL-3.0) 3 years ago
README.md chore: mention oasis-desktop in the README 2 years ago
package-lock.json Bump @types/koa__router from 8.0.4 to 8.0.7 1 year ago
package.json Bump @types/yargs from 16.0.2 to 17.0.2 1 year ago

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.

Screenshot of Oasis

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

Can I use Oasis as a desktop app?

Yes! Check out Oasis-Desktop!

Resources

See Also

License

AGPL-3.0