96 lines
4.0 KiB
Markdown
96 lines
4.0 KiB
Markdown
# 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)][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:
|
|
|
|
```sh
|
|
oasis
|
|
```
|
|
|
|
It will then pop open a browser window for you.
|
|
|
|
![Screenshot of Oasis](./docs/screenshot.png)
|
|
|
|
Use `oasis --help` to get configuration options. You can change the default
|
|
values with a custom [configuration](./docs/configuring.md).
|
|
|
|
## 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](https://nodejs.org/en/about/releases/), you should [download Node.js](https://nodejs.org/en/about/releases/) first.
|
|
|
|
Then you can install the stable version of Oasis:
|
|
|
|
```shell
|
|
npm -g install fraction/oasis#semver:
|
|
```
|
|
|
|
Or, for faster updates and less stability, install Oasis from GitHub and upgrade often.
|
|
|
|
```shell
|
|
npm -g install fraction/oasis
|
|
```
|
|
|
|
Check out [`install.md`](https://github.com/fraction/oasis/blob/master/docs/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](https://github.com/fraction/oasis/issues/267) 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
|
|
|
|
- [Architecture](https://github.com/fraction/oasis/blob/master/docs/architecture.md)
|
|
- [Chat room](https://matrix.to/#/!YQpqIZlvBVPYRwrkXp:matrix.org?via=matrix.org)
|
|
- [Contributing](https://github.com/fraction/oasis/blob/master/docs/contributing.md)
|
|
- [Help](https://github.com/fraction/oasis/issues/new)
|
|
- [Security policy](https://github.com/fraction/oasis/blob/master/docs/security.md)
|
|
- Source code: [Github](https://github.com/fraction/oasis.git) and [Gitlab](https://gitlab.com/fraction/oasis)
|
|
|
|
## See Also
|
|
|
|
- [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)
|
|
|
|
## License
|
|
|
|
AGPL-3.0
|
|
|
|
[ssb]: https://en.wikipedia.org/wiki/Secure_Scuttlebutt
|