3758bbf636
Problem: The install instructions in the readme contains quotes because it has a `*`, but `#semver:` does what we need without the quotes. The `docs/install.md` file also has some unnecessary complexity, like cloning via SSH (only useful for maintainers), which I think we can safely remove. Solution: Change the install instruction and reorganize `docs/install.md` to be more relevant to people who are installing from source. |
||
|---|---|---|
| .github | ||
| contrib | ||
| docs | ||
| scripts | ||
| src | ||
| .cspell.json | ||
| .dockerignore | ||
| .eslintrc.js | ||
| .gitignore | ||
| .huskyrc | ||
| .npmignore | ||
| .stylelintrc | ||
| .travis.yml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| README.md | ||
| package-lock.json | ||
| package.json | ||
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]
-c --config Show current default configuration [boolean] [default: false]
Configuration
The above options can be permanently set with a configuration file found in a standard folder for configuration, depending on your operating system:
- Linux:
$XDG_CONFIG_HOME/oasis/default.json. Usually this is/home/<your username>/.config/oasis/default.json - Windows
%APPDATA%\oasis\default.json. - Mac OS,
/Users/<your username>/Library/Preferences/oasis/default.json
The configuration file can override any or all of the command-line defaults. Here is an example customizing the port number and the "open" settings:
{
"open": false,
"port": 19192
}
Configuration Semantics
Which value is given is decided like this:
- If an argument is given on the command-line, use that value.
- Otherwise, use the value from the configuration file if present.
- If neither command-line nor configuration file are given, use the built-in default value.
Installation
Most people should install stable releases with npm and Node.js current or active LTS release.
npm -g install fraction/oasis#semver:
For faster updates and less stability, install from GitHub and upgrade often.
npm -g install fraction/oasis
Want more? Check out install.md.
Resources
See Also
License
AGPL-3.0