Browse Source

Updating sysgen docs

master
Ubergeek 3 years ago
parent
commit
ea7d9b2411
  1. 78
      articles/system/ansible.md
  2. 52
      articles/system/chat.md
  3. 330
      articles/system/thunix.md
  4. 64
      articles/system/tildegit.org.md

78
articles/system/ansible.md

@ -1,74 +1,42 @@
man {#man align="center"}
===
man(8) Ansible on Thunix man(8)
[NAME](#NAME)\
[SYNOPSIS](#SYNOPSIS)\
[DESCRIPTION](#DESCRIPTION)\
[SEE ALSO](#SEE%20ALSO)\
[BUGS](#BUGS)\
[AUTHOR](#AUTHOR)\
NAME Ansible on Thunix - how we manage the server
------------------------------------------------------------------------
SYNOPSIS ansible-pull
NAME []()
---------
DESCRIPTION We use ansible to manage the servers running the systems and
services for Thunix. Ansible consists of a "playbook" of YAML files,
that declare the state of the system.
Ansible on Thunix - how we manage the server
The first step is to clone the repo used to manage the environment:
SYNOPSIS []()
-------------
git clone git@ttm.sh:thunix/ansible.git (You will need a tidegit account for this, and a key loaded into your account there)
ansible-pull
From there, the typical github-type workflow is used:
DESCRIPTION []()
----------------
* Create a local branch, to track your issue's changes.
We use ansible to manage the servers running the systems and services
for Thunix. Ansible consists of a "playbook" of YAML files, that declare
the state of the system.
* Commit changes to your local branch.
The first step is to clone the repo used to manage the environment:
* Send a URI pointing to your repo, with branch name to someone with merge permissions
git clone git@ttm.sh:thunix/ansible.git (You will need a tidegit account
for this, and a key loaded into your account there)
Inside of the tildegit interface:
From there, the typical github-type workflow is used:
* Create a new branch, selecting option to create a branch and pull request
\* Create a local branch, to track your issue’s changes.
* Make changes in your branch
\* Commit changes to your local branch.
* Update PR
\* Send a URI pointing to your repo, with branch name to someone with
merge permissions
* Wait for someone to merge your changes
Inside of the tildegit interface:
Hourly, a job runs that pulls the latest version of the repo, and the runs ansible-playbook against the playbook. A sudoer can manually run this job, if desired,
and it's located at /etc/cron.hourly/ansible-pull.
\* Create a new branch, selecting option to create a branch and pull
request
SEE ALSO tildegit.org(8), git(8), ansible-playbook(8)
\* Make changes in your branch
BUGS No known bugs.
\* Update PR
AUTHOR Uber Geek (ubergeek@thunix.net)
\* Wait for someone to merge your changes
Hourly, a job runs that pulls the latest version of the repo, and the
runs ansible-playbook against the playbook. A sudoer can manually run
this job, if desired, and it’s located at /etc/cron.hourly/ansible-pull.
SEE ALSO []()
-------------
tildegit.org(8), git(8), ansible-playbook(8)
BUGS []()
---------
No known bugs.
AUTHOR []()
-----------
Uber Geek (ubergeek@thunix.net)
------------------------------------------------------------------------
1.1 19 February 2019 man(8)

52
articles/system/chat.md

@ -1,47 +1,19 @@
man {#man align="center"}
===
man(8) Thunix chat man(8)
[NAME](#NAME)\
[SYNOPSIS](#SYNOPSIS)\
[DESCRIPTION](#DESCRIPTION)\
[BUGS](#BUGS)\
[SEE ALSO](#SEE%20ALSO)\
[AUTHOR](#AUTHOR)\
NAME chat - chat script
------------------------------------------------------------------------
SYNOPSIS chat
NAME []()
---------
DESCRIPTION This is a simple script to launch weechat for new users, and
get them into the correct channel for chat and support.
chat - chat script
BUGS \* If you have a customized list of servers in your weechat config
already, this may try to connect you twice, and you'll have two nicks
going at once, which will be confusing. Once you've customized weechat
to your liking, just invoke 'weechat' or 'weechat-curses'.
SYNOPSIS []()
-------------
SEE ALSO weechat(8)
chat
AUTHOR Uber Geek (ubergeek@thunix.net)
DESCRIPTION []()
----------------
This is a simple script to launch weechat for new users, and get them
into the correct channel for chat and support.
BUGS []()
---------
\* If you have a customized list of servers in your weechat config
already, this may try to connect you twice, and you’ll have two nicks
going at once, which will be confusing. Once you’ve customized weechat
to your liking, just invoke ’weechat’ or ’weechat-curses’.
SEE ALSO []()
-------------
weechat(8)
AUTHOR []()
-----------
Uber Geek (ubergeek@thunix.net)
------------------------------------------------------------------------
1.1 19 February 2019 man(8)

330
articles/system/thunix.md

@ -1,224 +1,120 @@
man {#man align="center"}
===
[NAME](#NAME)\
[SYNOPSIS](#SYNOPSIS)\
[ADMINISTRATORS](#ADMINISTRATORS)\
[DESCRIPTION](#DESCRIPTION)\
[Purpose](#Purpose)\
[Terms of Service](#Terms%20of%20Service)\
[Architecture](#Architecture)\
[SEE ALSO](#SEE%20ALSO)\
[AUTHOR](#AUTHOR)\
------------------------------------------------------------------------
NAME []()
---------
Thunix - a public Linux server
SYNOPSIS []()
-------------
ssh thunix.net
ADMINISTRATORS []()
-------------------
List of system adminstrators are:
\* amcclure - Email: amcclure@thunix.net\
IRC: amcclure/irc.tilde.chat, amcclure/irc.freenode.net
\* naglfar - Email: naglfar@thunix.net\
IRC: Naglfar/irc.tilde.chat, Naglfar/irc.freenode.net
\* ubergeek - Email: ubergeek@thunix.net, ubergeek@yourtilde.com\
- IRC: ubergeek/irc.tilde.chat, ub3g33k/irc.freenode.net
\* fosslinux - Email: fosslinux@thunix.net\
- IRC: fosslinux/irc.tilde.chat
DESCRIPTION []()
----------------
Thunix is a publicly accesible Linux server, running Debian 9, and
managed using ansible playbooks.
There are many optional things to do on Thunix. There is IRC chat
availble with the weechat client. Most build tools are available to you
as well, to include git, make, gcc, go, python, and perl. Mail facilties
are also available for you to use via alpine, mutt, or even mailx.
To enter chat, just type ’chat’ and hit enter. You’ll be dropped into
the \#thunix chat room on the irc.tilde.chat network.
You should create an account at tildegit.org, where Thunix’s git repos
are hosted, to include the system configuration definition files.
Ansible is the tool we use to configure the systems that comprise
Thunix. Git and ansible are two tools your should familiarize yourself
with.
Purpose []()
------------
The goal of Thunix is to be an open and collaborative environment,
conducive to learning the principles of \*Nix operating systems,
regarding how they work, how to administer them, how to use them, and
how to collaborate using them.
Thunix tries to adhere to the values and philosophy of the Hacker Ethic
whenever possible. The hacker ethics and beliefs as described by Levy
are:
+--------------------------+--------------------------+--------------------------+
| | | \* Access to computers - |
| | | and anything which might |
| | | teach you something |
| | | about the way the world |
| | | works - should be |
| | | unlimited and total. |
| | | Always yield to the |
| | | Hands-On Imperative! |
+--------------------------+--------------------------+--------------------------+
| | | \* All information |
| | | should be free |
+--------------------------+--------------------------+--------------------------+
| | | \* Mistrust authority - |
| | | promote decentralization |
+--------------------------+--------------------------+--------------------------+
| | | \* Hackers should be |
| | | judged by their hacking, |
| | | not criteria such as |
| | | degrees, age, race, sex, |
| | | or position |
+--------------------------+--------------------------+--------------------------+
| | | \* You can create art |
| | | and beauty on a computer |
+--------------------------+--------------------------+--------------------------+
| | | \* Computers can change |
| | | your life for the better |
+--------------------------+--------------------------+--------------------------+
Thunix will never use proprietary software but users can do that if they
wish. This is something they should avoid however.
Terms of Service []()
---------------------
Nothing is without its rules and regulations; thunix is no exception.
Below are the site’s service terms. Everything in this page should be
clear to everyone who wishes to use thunix’s services; failure to abide
by these terms can result in penalties such as service bans and may
result in legal action against any offending users, depending on the
severity of each case and any other individuals who may have been
affected. Thunix may conduct investigations on any suspected violations,
and we will cooperate with law enforcement agencies with their
investigations. Be sure to read this page carefully and understand it.
You are responsibe for checking your local mail account from time to
time. This email address is the only one we retain, and as such, any
warnings and notices regarding your account, or service status will be
sent to this account.
+--------------------------------------+--------------------------------------+
| | \* Deliberately defacing the |
| | accounts of other users |
+--------------------------------------+--------------------------------------+
| | \* Deliberately trying to disrupt |
| | thunix’s server |
+--------------------------------------+--------------------------------------+
| | \* Using thunix as a launch pad for |
| | disrupting other servers |
+--------------------------------------+--------------------------------------+
| | \* Using thunix to impersonate other |
| | websites and businesses for criminal |
| | purposes |
+--------------------------------------+--------------------------------------+
| | \* Storing/distributing pornography |
| | of any genre and medium (especially |
| | child pornography) |
+--------------------------------------+--------------------------------------+
| | \* Storing/distributing content that |
| | defames any individual |
+--------------------------------------+--------------------------------------+
| | \* Promoting racial, ethnic, |
| | religious, political and other forms |
| | of bigotry |
+--------------------------------------+--------------------------------------+
| | \* Storing/distributing, promoting, |
| | or encouraging use of |
| | pirated/cracked software, license |
| | keys, license/registration |
| | circumvention programs, or any |
| | questionable programs/scripts that |
| | can risk causing unauthorized |
| | modifications, or disrupts network |
| | services for any programs or |
| | devices. |
+--------------------------------------+--------------------------------------+
| | \* Mining cryptocurrencies |
+--------------------------------------+--------------------------------------+
| | \* Spamming on any forums, mailing |
| | lists, irc channels, newsgroups, |
| | etc. |
+--------------------------------------+--------------------------------------+
| | \* Leaking or publishing any user’s |
| | or individual’s personal information |
| | without that person’s consent. |
+--------------------------------------+--------------------------------------+
Copyright infringement is not allowed on thunix, and we will not allow
any illegal content to be distributed. It’s also expected that all users
respect the copyrights of those who produce original content of any kind
and only share if the author or license grants you permission. Content
hosted on accounts used for external file storage must also follow
copyright law.
If you want to request for content you own the copyright for to be
removed from thunix, please refer to our abuse reporting page
(https://www.thunix.net/abuse.php). In the email, please identify who
you are, if you are the copyright holder or legally representing them,
the exact files you want removed with links to the files and infringed
content, and contact information such as phone numbers or a reply-to
email address.
Users that repeatedly violate the Terms of Service will have their
account removed. Depending on the degree of the offense, their account
may be removed immediately. These terms also apply to communication
services such as forums, mailing lists, irc channels, newsgroups, and
any other service either hosted on or used for thunix. If you come
across anything that violates the terms of service, please let us know
with the abuse reporting page (https://www.thunix.net/abuse.php).
Architecture []()
-----------------
The Thunix system consists of one server, running Debian 9, which runs
inside of an LXD container. This allows for an out-of-band
administration of the host, in case of configuration-gone-awry.
man(8) Thunix man(8)
NAME Thunix - a public Linux server
SYNOPSIS ssh thunix.net
ADMINISTRATORS List of system adminstrators are:
* amcclure - Email: amcclure@thunix.net
IRC: amcclure/irc.tilde.chat, amcclure/irc.freenode.net
* naglfar - Email: naglfar@thunix.net
IRC: Naglfar/irc.tilde.chat, Naglfar/irc.freenode.net
* ubergeek - Email: ubergeek@thunix.net, ubergeek@yourtilde.com
- IRC: ubergeek/irc.tilde.chat, ub3g33k/irc.freenode.net
* fosslinux - Email: fosslinux@thunix.net
- IRC: fosslinux/irc.tilde.chat
DESCRIPTION Thunix is a publicly accesible Linux server, running Debian
9, and managed using ansible playbooks.
There are many optional things to do on Thunix. There is IRC chat availble with the weechat client. Most build tools are available to you as well, to include
git, make, gcc, go, python, and perl. Mail facilties are also available for you to use via alpine, mutt, or even mailx.
To enter chat, just type 'chat' and hit enter. You'll be dropped into the #thunix chat room on the irc.tilde.chat network.
You should create an account at tildegit.org, where Thunix's git repos are hosted, to include the system configuration definition files.
Ansible is the tool we use to configure the systems that comprise Thunix. Git and ansible are two tools your should familiarize yourself with.
Purpose The goal of Thunix is to be an open and collaborative
environment, conducive to learning the principles of \*Nix operating
systems, regarding how they work, how to administer them, how to use
them, and how to collaborate using them.
Thunix tries to adhere to the values and philosophy of the Hacker Ethic whenever possible. The hacker ethics and beliefs as described by Levy are:
* Access to computers - and anything which might teach you something about the way the world works - should be unlimited and total. Always yield to the
Hands-On Imperative!
* All information should be free
* Mistrust authority - promote decentralization
* Hackers should be judged by their hacking, not criteria such as degrees, age, race, sex, or position
Hourly, thunix reaches out to tildegit, pull down the latest version of
the configuration, and run the configuration tool, ensuring it is in a
known, and easily replicable state.
* You can create art and beauty on a computer
All repos for system configuration, Thunix-supplied/ran code is hosted
on tildegit.org. Thunix users are recommended to create accounts on
tildegit, and contribute pull requests to make their desired changes to
the system, or very minimally, submit issues for problems and/or
requests.
* Computers can change your life for the better
Thunix will never use proprietary software but users can do that if they wish. This is something they should avoid however.
Terms of Service Nothing is without its rules and regulations; thunix is
no exception. Below are the site's service terms. Everything in this
page should be clear to everyone who wishes to use thunix's services;
failure to abide by these terms can result in penalties such as service
bans and may result in legal action against any offending users,
depending on the severity of each case and any other individuals who may
have been affected. Thunix may conduct investigations on any suspected
violations, and we will cooperate with law enforcement agencies with
their investigations. Be sure to read this page carefully and understand
it.
You are responsibe for checking your local mail account from time to time. This email address is the only one we retain, and as such, any warnings and notices
regarding your account, or service status will be sent to this account.
* Deliberately defacing the accounts of other users
* Deliberately trying to disrupt thunix's server
* Using thunix as a launch pad for disrupting other servers
* Using thunix to impersonate other websites and businesses for criminal purposes
* Storing/distributing pornography of any genre and medium (especially child pornography)
* Storing/distributing content that defames any individual
* Promoting racial, ethnic, religious, political and other forms of bigotry
* Storing/distributing, promoting, or encouraging use of pirated/cracked software, license keys, license/registration circumvention programs, or any ques‐
tionable programs/scripts that can risk causing unauthorized modifications, or disrupts network services for any programs or devices.
* Mining cryptocurrencies
* Spamming on any forums, mailing lists, irc channels, newsgroups, etc.
* Leaking or publishing any user's or individual's personal information without that person's consent.
Copyright infringement is not allowed on thunix, and we will not allow any illegal content to be distributed. It's also expected that all users respect the copy‐
rights of those who produce original content of any kind and only share if the author or license grants you permission. Content hosted on accounts used for exter‐
nal file storage must also follow copyright law.
If you want to request for content you own the copyright for to be removed from thunix, please refer to our abuse reporting page (https://www.thu‐
nix.net/abuse.php). In the email, please identify who you are, if you are the copyright holder or legally representing them, the exact files you want removed with
links to the files and infringed content, and contact information such as phone numbers or a reply-to email address.
Users that repeatedly violate the Terms of Service will have their account removed. Depending on the degree of the offense, their account may be removed immedi‐
ately. These terms also apply to communication services such as forums, mailing lists, irc channels, newsgroups, and any other service either hosted on or used
for thunix. If you come across anything that violates the terms of service, please let us know with the abuse reporting page (https://www.thunix.net/abuse.php).
Architecture The Thunix system consists of one server, running Debian 9,
which runs inside of an LXD container. This allows for an out-of-band
administration of the host, in case of configuration-gone-awry.
SEE ALSO []()
-------------
Hourly, thunix reaches out to tildegit, pull down the latest version of the configuration, and run the configuration tool, ensuring it is in a known, and easily
replicable state.
ssh(8), weechat(8), git(8), make(8), gcc(8), go(8), python(8), perl(8),
alpine(8), mutt(8), mailx(8), ansible-playbook(8), tildegit.org(8)
All repos for system configuration, Thunix-supplied/ran code is hosted on tildegit.org. Thunix users are recommended to create accounts on tildegit, and contrib‐
ute pull requests to make their desired changes to the system, or very minimally, submit issues for problems and/or requests.
AUTHOR []()
-----------
SEE ALSO ssh(8), weechat(8), git(8), make(8), gcc(8), go(8), python(8),
perl(8), alpine(8), mutt(8), mailx(8), ansible-playbook(8),
tildegit.org(8)
Uber Geek (ubergeek@thunix.net) amcclure (amcclure@thunix.net)
AUTHOR Uber Geek (ubergeek@thunix.net) amcclure (amcclure@thunix.net)
------------------------------------------------------------------------
1.5 24 May 2019 man(8)

64
articles/system/tildegit.org.md

@ -1,61 +1,29 @@
man {#man align="center"}
===
man(8) tildegit.org" man(8)
[NAME](#NAME)\
[SYNOPSIS](#SYNOPSIS)\
[DESCRIPTION](#DESCRIPTION)\
[SEE ALSO](#SEE%20ALSO)\
[BUGS](#BUGS)\
[AUTHOR](#AUTHOR)\
NAME tildegit.org - a public web based source repository for the
tildeverse
------------------------------------------------------------------------
SYNOPSIS https://tildegit.org
NAME []()
---------
tildegit.org - a public web based source repository for the tildeverse
SYNOPSIS []()
-------------
https://tildegit.org
DESCRIPTION []()
----------------
Tildegit is a web based source control system available for the
tildeverse, that runs gitea. Thunix uses tildegit.org for all source
DESCRIPTION Tildegit is a web based source control system available for
the tildeverse, that runs gitea. Thunix uses tildegit.org for all source
control.
The following git repos are used:
\* ansible (https://tildegit.org/thunix/ansible) This repo stores the
configuration spec for all machines comprising Thunix. The repo consists
of declarative YAML files that describes the state the machines should
be in.
\* www (https://tildegit.org/thunix/www) This repo stores the source
code that makes up the https:/thunix.net website. It’s mostly php.
\* documentation (https://tildegit.org/thunix/documentation) This repo
stores the man pages, and accompanying documentation for the system.
The following git repos are used:
\* thunix\_gopher (https://tildegit.org/thunix/thunix\_gopher) This repo
houses our gopher hole
* ansible (https://tildegit.org/thunix/ansible) This repo stores the configuration spec for all machines comprising Thunix. The repo consists of declarative YAML
files that describes the state the machines should be in.
SEE ALSO []()
-------------
* www (https://tildegit.org/thunix/www) This repo stores the source code that makes up the https:/thunix.net website. It's mostly php.
git(8), ansible(8)
* documentation (https://tildegit.org/thunix/documentation) This repo stores the man pages, and accompanying documentation for the system.
BUGS []()
---------
* thunix_gopher (https://tildegit.org/thunix/thunix_gopher) This repo houses our gopher hole
No known bugs.
SEE ALSO git(8), ansible(8)
AUTHOR []()
-----------
BUGS No known bugs.
Uber Geek (ubergeek@thunix.net)
AUTHOR Uber Geek (ubergeek@thunix.net)
------------------------------------------------------------------------
1.2 24 May 2019 man(8)

Loading…
Cancel
Save