2019-06-24 19:19:06 +00:00
# Oasis
2020-03-04 00:06:36 +00:00
Oasis is a **free, open-source, peer-to-peer social application** that helps
you follow friends and discover new ones on [Secure Scuttlebutt (SSB)][ssb].
2020-02-11 23:42:34 +00:00
2020-03-04 00:06:36 +00:00
**🦀 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
2020-03-09 22:07:49 +00:00
spam again. Switch to any SSB app you want at any time.
2020-02-11 23:42:34 +00:00
2020-03-04 00:06:36 +00:00
**🌐 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.
2020-02-11 23:42:34 +00:00
2020-03-04 00:06:36 +00:00
**🏰 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.
2019-06-24 19:19:06 +00:00
2020-03-01 19:39:01 +00:00
## Example
2020-02-10 18:54:19 +00:00
2020-03-02 19:28:08 +00:00
After installing, launch Oasis from the command line by running:
2020-03-02 19:38:08 +00:00
2020-03-01 19:39:01 +00:00
```sh
oasis
2019-06-24 19:19:06 +00:00
```
2020-03-02 19:38:08 +00:00
2020-03-02 19:28:08 +00:00
It will then pop open a browser window for you.
2019-06-24 19:19:06 +00:00
2020-03-01 19:39:01 +00:00
![Screenshot of Oasis ](./docs/screenshot.png )
2020-02-23 00:08:21 +00:00
2020-03-04 00:06:36 +00:00
Use `oasis --help` to get configuration options. You can change the default
values with a custom [configuration ](./docs/configuring.md ).
2020-02-23 00:08:21 +00:00
2019-06-24 19:19:06 +00:00
## Installation
2020-03-02 19:38:08 +00:00
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 ](https://nodejs.org/en/about/releases/ ), you should [download Node.js ](https://nodejs.org/en/about/releases/ ) first.
2020-03-02 19:28:08 +00:00
Then you can install the stable version of Oasis:
2019-06-24 19:19:06 +00:00
```shell
2020-02-29 16:31:07 +00:00
npm -g install fraction/oasis#semver:
2019-06-24 19:19:06 +00:00
```
2020-03-02 19:28:08 +00:00
Or, for faster updates and less stability, install Oasis from GitHub and upgrade often.
2020-02-03 17:41:37 +00:00
```shell
2020-02-29 16:31:07 +00:00
npm -g install fraction/oasis
2020-02-03 17:41:37 +00:00
```
2020-03-01 19:39:01 +00:00
Check out [`install.md` ](https://github.com/fraction/oasis/blob/master/docs/install.md )
for more information.
2020-01-03 20:03:21 +00:00
2020-03-02 21:28:35 +00:00
## FAQ
### Can I use the same profile from multiple computers?
2020-03-09 22:07:49 +00:00
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 ](https://github.com/fraction/oasis/issues/267 ) which ties your multiple profiles together.
2020-03-02 21:28:35 +00:00
### Can I run this at the same time as Patchwork and other SSB apps?
2020-03-09 22:07:49 +00:00
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.
2020-03-02 21:28:35 +00:00
2020-03-09 22:07:49 +00:00
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.
2020-03-02 21:28:35 +00:00
| App | Runs its own SSB server | Can use SSB server of another app |
2020-03-09 22:07:49 +00:00
| --------- | ---------------------------------- | ---------------------------------------------- |
2020-03-02 21:28:35 +00:00
| Oasis | Yes, unless one is already running | Yes |
| Patchwork | Yes | No, only uses its own server |
2020-03-19 04:05:20 +00:00
| Patchbay | Yes | No, only uses its own server |
2020-03-02 21:28:35 +00:00
| Patchfox | No | Yes, depends on other apps to provide a server |
2019-09-24 21:21:28 +00:00
## Resources
2020-01-28 17:24:14 +00:00
- [Architecture ](https://github.com/fraction/oasis/blob/master/docs/architecture.md )
2020-03-27 16:23:13 +00:00
- [Chat room ](https://matrix.to/#/!YQpqIZlvBVPYRwrkXp:matrix.org?via=matrix.org )
- [Contributing ](https://github.com/fraction/oasis/blob/master/docs/contributing.md )
2020-02-02 19:33:33 +00:00
- [Help ](https://github.com/fraction/oasis/issues/new )
2020-03-27 16:23:13 +00:00
- [Security policy ](https://github.com/fraction/oasis/blob/master/docs/security.md )
- [Source code ](https://github.com/fraction/oasis.git )
2019-09-24 21:21:28 +00:00
2019-06-24 19:19:06 +00:00
## See Also
2020-02-11 23:42:34 +00:00
- [Patchbay ](https://github.com/ssbc/patchbay )
- [Patchwork ](https://github.com/ssbc/patchwork )
- [SSB-Browser ](https://github.com/arj03/ssb-browser-demo )
- [SSB-Server ](https://github.com/ssbc/ssb-server )
- [Yap ](https://github.com/dominictarr/yap )
2019-06-24 19:19:06 +00:00
## License
2019-09-27 00:19:18 +00:00
AGPL-3.0
2020-02-11 23:42:34 +00:00
[ssb]: https://en.wikipedia.org/wiki/Secure_Scuttlebutt