git ssb

1
var com = require('../../com.part')
2
var page = require('../../page.part')
3
4
module.exports = () => page({
5
  title: 'Join a Pub',
6
  section: 'docs',
7
  tab: 'docs-social',
8
  path :'/docs/social/join-a-pub.html',
9
  content: `
10
    <p>
11
      If you want to connect with users across the net, you need to be followed by a Pub server.
12
    </p>
13
    <h2>What are Pubs?</h2>
14
    <p>
15
      Some homes and offices can't accept peer-to-peer connections over the Internet.
16
      You can solve this with <a href="https://en.wikipedia.org/wiki/Hole_punching_(networking)">"NAT Hole-Punching,"</a> but it can be slow and sometimes fails.
17
      Instead, Scuttlebot solves this with Pubs.
18
    </p>
19
    <p>
20
      Pubs are bot-users that have public IP addresses, and who follow real users.
21
      They dont have any special authority, but they do keep your data backed up and easy-to-access.
22
      You can have more than one, and change pubs any time, but you need at least one to reach friends over the net.
23
    </p>
24
    <blockquote>
25
      If you want to only sync by Wifi, or dont want to sync with anyone at all, you can skip this step.
26
    </blockquote>
27
    <h2>Joining a Pub</h2>
28
    <p>
29
      First get an invite-code from a Pub operator, or <a href="/docs/config/create-a-pub.html">create your own Pub.</a>
30
      You can ask for invites via the #scuttlebutt channel, on Freenode.
31
    </p>
32
    <p>
33
      To use the invite, follow this command:
34
    </p>
35
    ${ com.code({ js: jsSnippet, bash: bashSnippet }) }
36
    <p>
37
      Your Scuttlebot will now connect to, and sync with, the Pub. Other users can then sync with the pub to receive your feed.
38
    </p>
39
40
    <ul class="see-also">
41
      <li><a href="/apis/scuttlebot/invite.html">Scuttlebot.Invite API</a></li>
42
    </ul>
43
    <p class="next"><a href="/docs/advanced/links.html">Links</a></p>
44
  `
45
})
46
47
48
var jsSnippet = `
49
sbot.invite.accept(code, function (err) {
50
  // ...
51
})
52
`
53
54
var bashSnippet = `
55
sbot invite.accept {code}
56
`