skel

starter files for new garbash accounts
git clone git://git.garbash.com/alex/skel
Log | Files | Refs | README

ONBOARDING.txt (3305B)


      1                 .
      2                 ').
      3                /;((
      4              .'____`.
      5              | g    | create
      6              |  a   | something
      7              |   r  | worth
      8              | bash | rewriting
      9              `-____-'
     10 
     11 
     12 Welcome to garbash!
     13 
     14 While our invite-only nature means you probably have
     15 a sysadmin on your speed-dial, we wanted to put together
     16 a small collection of getting-started tips for you to
     17 refer to as you take your first steps with your new
     18 account!
     19 
     20 If you're new to OpenBSD or UNIX in general, a good
     21 starting place is help(1) and intro(1). For the unfamiliar,
     22 the name(N) syntax refers to a "man page" (manual page),
     23 which can be accessed with the man(1) tool:
     24 
     25 	$ man help
     26 
     27 Or, if there are multiple versions of the page (like intro):
     28 
     29 	$ man intro 1
     30 
     31 The 1 refers to the first section of the manual (7 is misc,
     32 6 is games, you get the idea).
     33 
     34 Your new account has been provisioned with the following
     35 services:
     36 
     37 1. A website
     38 
     39   All content in /var/www/htdocs/~user is served
     40   on the world-wide-web at garbash.com/~user.
     41 
     42 2. An email address
     43 
     44   user@garbash.com is your new email address!
     45   It can receive and send externally, but your
     46   inbox can only be accessed on this machine
     47   (for now). More on access below. You're also
     48   subscribed to all 4 of our mailing lists:
     49   dev@, announce@, misc@, and bugs@. They're a
     50   great place to collaborate and discuss if
     51   no one is on IRC.
     52 
     53   For access, we recommend using mutt(1), which
     54   has already been configured to open your mailbox.
     55   Just type `mutt` and read the UI for basic
     56   keybindings! (arrows to navigate, enter to read)
     57 
     58 3. An IRC bouncer account
     59 
     60   IRC (Internet Relay Chat) is like Slack, but
     61   retro. It can be accessed via a terminal client
     62   like irssi(1) or our web client (irc.garbash.com).
     63   For the web client you'll need to be on the VPN.
     64   Your account is actually registered with our
     65   bouncer, a program that keeps you connected and
     66   maintains the backlog of messages when you're
     67   offline. You don't need to worry about this with
     68   the web client (it just works), but for irssi(1),
     69   you'll want to connect to the bouncer!
     70 
     71   To get started quick, navigate to irc.garbash.com,
     72   enter your username and password (in your email).
     73   Once in, hit "Add network", choose:
     74 
     75     Hostname: irc.garbash.com
     76       
     77   Hit enter, and voila! Join #garbash and say hello!
     78       
     79 4. A VPN certificate
     80 
     81   A WireGuard VPN connection is necessary to
     82   access certain internal-only resources, including
     83   our web IRC client (irc.garbash.com) and our
     84   mail archive (lists.garbash.com). The wg-quick(8)
     85   file is in your inbox, and should only be used
     86   on one device. If you need another cert, just
     87   let an admin know! (~alex or ~anthony)
     88 
     89   On Linux/BSD, configure wireguard with just
     90 
     91 	$ wg-quick up client.conf
     92 
     93   On macOS, you can paste the contents of client.conf
     94   into the dropdown configuration tool.
     95 
     96 5. Git hosting
     97 
     98   You can publish your git repos by running the
     99   newrepo(1) command. From there, clone the repo
    100   or push an existing repo to it and updates will
    101   be rendered on git.garbash.com (public!)
    102 
    103 ---
    104 
    105 Of course, if you have any questions, don't hesitate
    106 to ask at misc@garbash.com or on #garbash on IRC!
    107 
    108 We hope you enjoy your stay! While you're here make
    109 sure you create something worth rewriting :)