https://github.com/ssb-junkyard/ssbui

install package for desktop users [deprecated]
https://github.com/ssb-junkyard/ssbui

Last synced: about 1 month ago
JSON representation

install package for desktop users [deprecated]

• Host: GitHub
• URL: https://github.com/ssb-junkyard/ssbui
• Owner: ssb-junkyard
• Created: 2014-12-08T23:35:49.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2019-01-11T21:02:35.000Z (almost 6 years ago)
• Last Synced: 2024-09-19T03:49:50.891Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 7
• Watchers: 15
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - ssb-junkyard/ssbui - install package for desktop users [deprecated] (others)

README

        
# SSBui - ssb install package for desktop users

To setup:

```

npm install -g ssbui

ssbui

```

If this gives you a permissions error, [use the method here (preferred)](http://stackoverflow.com/questions/19352976/npm-modules-wont-install-globally-without-sudo) or install and run using sudo.

Then open `localhost:2000` in your browser and get started!

## Hosting a Public Relay

To give good uptime to the ssb network, bot users run as "public relays." They follow users who want to be hosted; friends of friends contact the relay bot to get each others' messages from it.

To setup a public relay host, ssh into your server and run the following commands:

```

npm install -g ssbui

ssbui server --hostname    # do this in a screen which you can detach

ssbui publish --type profile --nickname 

```

For instance:

```

ssbui server --hostname goodpeople.com

ssbui publish --type profile --nickname goodpeople.com

```

To host somebody on the relay, you have the relay follow the target user. You can do that with this command:

```

ssbui publish --type follows --rel follows --feed 

```

For instance:

```

ssbui publish --type follows --rel follows --feed r+MiCfhoSQm10BfneXkmtG/H5sioWZW0yrPOkXr5i94=.blake2s

```

## Generating an Invite Code

Invite codes allow public relays to distribute secrets that allow a set number of local clients to automatically follow and be followed by the public relay.

To generate an invite code, run the following command on your public relay (with ssbui running):

```

ssbui invite.create 

```

For instance:

```

ssbui invite.create 10

```

To consume the invite code, copy and paste the output of the above `invite.create` command into the "Add contact" dialog of a local ssbui interface.

## Adding a Public Relay

To add a public relay to your local device (eg one you hosted) run the following command on your local computer (with ssbui running):

```

ssbui publish --type pub --address 

```

For instance:

```

ssbui publish --type pub --address goodpeople.com

```