commit edbbf7d2411c35a04e904d497c08f1031f61aa42 (patch)
parent 319abb710528ebee494d68d5c5b59623f5fe5ea5
Author: alex <alex@garbash.com>
Date: Mon, 15 Nov 2021 23:31:45 -0500
onboarding: Add ONBOARDING readme for new accounts
This is installed into /etc/skel/README.txt and emailed to
new users (as well as being in their home directory).
Diffstat:
| A | ONBOARDING.txt | | | 109 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 109 insertions(+), 0 deletions(-)
diff --git a/ONBOARDING.txt b/ONBOARDING.txt
@@ -0,0 +1,109 @@
+ .
+ ').
+ /;((
+ .'____`.
+ | g | create
+ | a | something
+ | r | worth
+ | bash | rewriting
+ `-____-'
+
+
+Welcome to garbash!
+
+While our invite-only nature means you probably have
+a sysadmin on your speed-dial, we wanted to put together
+a small collection of getting-started tips for you to
+refer to as you take your first steps with your new
+account!
+
+If you're new to OpenBSD or UNIX in general, a good
+starting place is help(1) and intro(1). For the unfamiliar,
+the name(N) syntax refers to a "man page" (manual page),
+which can be accessed with the man(1) tool:
+
+ $ man help
+
+Or, if there are multiple versions of the page (like intro):
+
+ $ man intro 1
+
+The 1 refers to the first section of the manual (7 is misc,
+6 is games, you get the idea).
+
+Your new account has been provisioned with the following
+services:
+
+1. A website
+
+ All content in /var/www/htdocs/~user is served
+ on the world-wide-web at garbash.com/~user.
+
+2. An email address
+
+ user@garbash.com is your new email address!
+ It can receive and send externally, but your
+ inbox can only be accessed on this machine
+ (for now). More on access below. You're also
+ subscribed to all 4 of our mailing lists:
+ dev@, announce@, misc@, and bugs@. They're a
+ great place to collaborate and discuss if
+ no one is on IRC.
+
+ For access, we recommend using mutt(1), which
+ has already been configured to open your mailbox.
+ Just type `mutt` and read the UI for basic
+ keybindings! (arrows to navigate, enter to read)
+
+3. An IRC bouncer account
+
+ IRC (Internet Relay Chat) is like Slack, but
+ retro. It can be accessed via a terminal client
+ like irssi(1) or our web client (irc.garbash.com).
+ For the web client you'll need to be on the VPN.
+ Your account is actually registered with our
+ bouncer, a program that keeps you connected and
+ maintains the backlog of messages when you're
+ offline. You don't need to worry about this with
+ the web client (it just works), but for irssi(1),
+ you'll want to connect to the bouncer!
+
+ To get started quick, navigate to irc.garbash.com,
+ enter your username and password (in your email).
+ Once in, hit "Add network", choose:
+
+ Hostname: irc.garbash.com
+
+ Hit enter, and voila! Join #garbash and say hello!
+
+4. A VPN certificate
+
+ A WireGuard VPN connection is necessary to
+ access certain internal-only resources, including
+ our web IRC client (irc.garbash.com) and our
+ mail archive (lists.garbash.com). The wg-quick(8)
+ file is in your inbox, and should only be used
+ on one device. If you need another cert, just
+ let an admin know! (~alex or ~anthony)
+
+ On Linux/BSD, configure wireguard with just
+
+ $ wg-quick up client.conf
+
+ On macOS, you can paste the contents of client.conf
+ into the dropdown configuration tool.
+
+5. Git hosting
+
+ You can publish your git repos by running the
+ newrepo(1) command. From there, clone the repo
+ or push an existing repo to it and updates will
+ be rendered on git.garbash.com (public!)
+
+---
+
+Of course, if you have any questions, don't hesitate
+to ask at misc@garbash.com or on #garbash on IRC!
+
+We hope you enjoy your stay! While you're here make
+sure you create something worth rewriting :)
