added html export of README.org

author: Casper <me@skylarcloud.xyz> 2024-12-19 11:20:55 -0700
committer: Casper <me@skylarcloud.xyz> 2024-12-19 11:20:55 -0700
commit: 4301b484658b8d02fd1b239bae62d0af313ff5cf (patch)
tree: 4ae91c7b292eddf278c47131002e0abe906571df /README.html
parent: 842303f6b1c50d303331f2122320fa960854e298 (diff)
1 files changed, 396 insertions, 0 deletions
diff --git a/README.html b/README.html
new file mode 100644
index 0000000..36ea874
--- /dev/null
+++ b/README.html
@@ -0,0 +1,396 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+<!-- 2024-12-19 Thu 11:15 -->
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<title>README</title>
+<meta name="generator" content="Org Mode" />
+<style type="text/css">
+  #content { max-width: 60em; margin: auto; }
+  .title  { text-align: center;
+             margin-bottom: .2em; }
+  .subtitle { text-align: center;
+              font-size: medium;
+              font-weight: bold;
+              margin-top:0; }
+  .todo   { font-family: monospace; color: red; }
+  .done   { font-family: monospace; color: green; }
+  .priority { font-family: monospace; color: orange; }
+  .tag    { background-color: #eee; font-family: monospace;
+            padding: 2px; font-size: 80%; font-weight: normal; }
+  .timestamp { color: #bebebe; }
+  .timestamp-kwd { color: #5f9ea0; }
+  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
+  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
+  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
+  .underline { text-decoration: underline; }
+  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
+  p.verse { margin-left: 3%; }
+  pre {
+    border: 1px solid #e6e6e6;
+    border-radius: 3px;
+    background-color: #f2f2f2;
+    padding: 8pt;
+    font-family: monospace;
+    overflow: auto;
+    margin: 1.2em;
+  }
+  pre.src {
+    position: relative;
+    overflow: auto;
+  }
+  pre.src:before {
+    display: none;
+    position: absolute;
+    top: -8px;
+    right: 12px;
+    padding: 3px;
+    color: #555;
+    background-color: #f2f2f299;
+  }
+  pre.src:hover:before { display: inline; margin-top: 14px;}
+  /* Languages per Org manual */
+  pre.src-asymptote:before { content: 'Asymptote'; }
+  pre.src-awk:before { content: 'Awk'; }
+  pre.src-authinfo::before { content: 'Authinfo'; }
+  pre.src-C:before { content: 'C'; }
+  /* pre.src-C++ doesn't work in CSS */
+  pre.src-clojure:before { content: 'Clojure'; }
+  pre.src-css:before { content: 'CSS'; }
+  pre.src-D:before { content: 'D'; }
+  pre.src-ditaa:before { content: 'ditaa'; }
+  pre.src-dot:before { content: 'Graphviz'; }
+  pre.src-calc:before { content: 'Emacs Calc'; }
+  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
+  pre.src-fortran:before { content: 'Fortran'; }
+  pre.src-gnuplot:before { content: 'gnuplot'; }
+  pre.src-haskell:before { content: 'Haskell'; }
+  pre.src-hledger:before { content: 'hledger'; }
+  pre.src-java:before { content: 'Java'; }
+  pre.src-js:before { content: 'Javascript'; }
+  pre.src-latex:before { content: 'LaTeX'; }
+  pre.src-ledger:before { content: 'Ledger'; }
+  pre.src-lisp:before { content: 'Lisp'; }
+  pre.src-lilypond:before { content: 'Lilypond'; }
+  pre.src-lua:before { content: 'Lua'; }
+  pre.src-matlab:before { content: 'MATLAB'; }
+  pre.src-mscgen:before { content: 'Mscgen'; }
+  pre.src-ocaml:before { content: 'Objective Caml'; }
+  pre.src-octave:before { content: 'Octave'; }
+  pre.src-org:before { content: 'Org mode'; }
+  pre.src-oz:before { content: 'OZ'; }
+  pre.src-plantuml:before { content: 'Plantuml'; }
+  pre.src-processing:before { content: 'Processing.js'; }
+  pre.src-python:before { content: 'Python'; }
+  pre.src-R:before { content: 'R'; }
+  pre.src-ruby:before { content: 'Ruby'; }
+  pre.src-sass:before { content: 'Sass'; }
+  pre.src-scheme:before { content: 'Scheme'; }
+  pre.src-screen:before { content: 'Gnu Screen'; }
+  pre.src-sed:before { content: 'Sed'; }
+  pre.src-sh:before { content: 'shell'; }
+  pre.src-sql:before { content: 'SQL'; }
+  pre.src-sqlite:before { content: 'SQLite'; }
+  /* additional languages in org.el's org-babel-load-languages alist */
+  pre.src-forth:before { content: 'Forth'; }
+  pre.src-io:before { content: 'IO'; }
+  pre.src-J:before { content: 'J'; }
+  pre.src-makefile:before { content: 'Makefile'; }
+  pre.src-maxima:before { content: 'Maxima'; }
+  pre.src-perl:before { content: 'Perl'; }
+  pre.src-picolisp:before { content: 'Pico Lisp'; }
+  pre.src-scala:before { content: 'Scala'; }
+  pre.src-shell:before { content: 'Shell Script'; }
+  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
+  /* additional language identifiers per "defun org-babel-execute"
+       in ob-*.el */
+  pre.src-cpp:before  { content: 'C++'; }
+  pre.src-abc:before  { content: 'ABC'; }
+  pre.src-coq:before  { content: 'Coq'; }
+  pre.src-groovy:before  { content: 'Groovy'; }
+  /* additional language identifiers from org-babel-shell-names in
+     ob-shell.el: ob-shell is the only babel language using a lambda to put
+     the execution function name together. */
+  pre.src-bash:before  { content: 'bash'; }
+  pre.src-csh:before  { content: 'csh'; }
+  pre.src-ash:before  { content: 'ash'; }
+  pre.src-dash:before  { content: 'dash'; }
+  pre.src-ksh:before  { content: 'ksh'; }
+  pre.src-mksh:before  { content: 'mksh'; }
+  pre.src-posh:before  { content: 'posh'; }
+  /* Additional Emacs modes also supported by the LaTeX listings package */
+  pre.src-ada:before { content: 'Ada'; }
+  pre.src-asm:before { content: 'Assembler'; }
+  pre.src-caml:before { content: 'Caml'; }
+  pre.src-delphi:before { content: 'Delphi'; }
+  pre.src-html:before { content: 'HTML'; }
+  pre.src-idl:before { content: 'IDL'; }
+  pre.src-mercury:before { content: 'Mercury'; }
+  pre.src-metapost:before { content: 'MetaPost'; }
+  pre.src-modula-2:before { content: 'Modula-2'; }
+  pre.src-pascal:before { content: 'Pascal'; }
+  pre.src-ps:before { content: 'PostScript'; }
+  pre.src-prolog:before { content: 'Prolog'; }
+  pre.src-simula:before { content: 'Simula'; }
+  pre.src-tcl:before { content: 'tcl'; }
+  pre.src-tex:before { content: 'TeX'; }
+  pre.src-plain-tex:before { content: 'Plain TeX'; }
+  pre.src-verilog:before { content: 'Verilog'; }
+  pre.src-vhdl:before { content: 'VHDL'; }
+  pre.src-xml:before { content: 'XML'; }
+  pre.src-nxml:before { content: 'XML'; }
+  /* add a generic configuration mode; LaTeX export needs an additional
+     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
+  pre.src-conf:before { content: 'Configuration File'; }
+
+  table { border-collapse:collapse; }
+  caption.t-above { caption-side: top; }
+  caption.t-bottom { caption-side: bottom; }
+  td, th { vertical-align:top;  }
+  th.org-right  { text-align: center;  }
+  th.org-left   { text-align: center;   }
+  th.org-center { text-align: center; }
+  td.org-right  { text-align: right;  }
+  td.org-left   { text-align: left;   }
+  td.org-center { text-align: center; }
+  dt { font-weight: bold; }
+  .footpara { display: inline; }
+  .footdef  { margin-bottom: 1em; }
+  .figure { padding: 1em; }
+  .figure p { text-align: center; }
+  .equation-container {
+    display: table;
+    text-align: center;
+    width: 100%;
+  }
+  .equation {
+    vertical-align: middle;
+  }
+  .equation-label {
+    display: table-cell;
+    text-align: right;
+    vertical-align: middle;
+  }
+  .inlinetask {
+    padding: 10px;
+    border: 2px solid gray;
+    margin: 10px;
+    background: #ffffcc;
+  }
+  #org-div-home-and-up
+   { text-align: right; font-size: 70%; white-space: nowrap; }
+  textarea { overflow-x: auto; }
+  .linenr { font-size: smaller }
+  .code-highlighted { background-color: #ffff00; }
+  .org-info-js_info-navigation { border-style: none; }
+  #org-info-js_console-label
+    { font-size: 10px; font-weight: bold; white-space: nowrap; }
+  .org-info-js_search-highlight
+    { background-color: #ffff00; color: #000000; font-weight: bold; }
+  .org-svg { }
+</style>
+</head>
+<body>
+<div id="content" class="content">
+<h1 class="title">README</h1>
+<div id="outline-container-orgb513d84" class="outline-2">
+<h2 id="orgb513d84">Installation</h2>
+<div class="outline-text-2" id="text-orgb513d84">
+</div>
+<div id="outline-container-org7a267b0" class="outline-3">
+<h3 id="org7a267b0">Setup salt user-dirs</h3>
+<div class="outline-text-3" id="text-org7a267b0">
+<div class="org-src-container">
+<pre class="src src-bash"><span style="color: #5B6268;"># </span><span style="color: #5B6268;">In dom0</span>
+<span style="color: #ee7b29;">sudo</span> qubesctl state.sls qubes.user-dirs
+</pre>
+</div>
+
+<p>
+I sometimes run into the issue described here on a new install: <a href="https://github.com/QubesOS/qubes-issues/issues/8491">https://github.com/QubesOS/qubes-issues/issues/8491</a>. The solution that works consistantly for me is:
+</p>
+
+<div class="org-src-container">
+<pre class="src src-bash"><span style="color: #5B6268;"># </span><span style="color: #5B6268;">In dom0</span>
+<span style="color: #ee7b29;">ln</span> -s /srv/salt/qubes/user-dirs.top /srv/salt/_tops/base/user-dirs.top
+</pre>
+</div>
+</div>
+</div>
+<div id="outline-container-orgbfad215" class="outline-3">
+<h3 id="orgbfad215">Clone my repo</h3>
+<div class="outline-text-3" id="text-orgbfad215">
+<p>
+Open a terminal in some networked app qube (with git installed!), and clone my repository:
+</p>
+
+<div class="org-src-container">
+<pre class="src src-bash"><span style="color: #5B6268;"># </span><span style="color: #5B6268;">In dispXXXX</span>
+<span style="color: #ee7b29;">git</span> clone https://git.skylarcloud.xyz/salt-repo.git
+</pre>
+</div>
+</div>
+</div>
+<div id="outline-container-org12b1608" class="outline-3">
+<h3 id="org12b1608">Move it to dom0</h3>
+<div class="outline-text-3" id="text-org12b1608">
+<p>
+First, we&rsquo;ll turn the repo into an archive with tar:
+</p>
+
+<div class="org-src-container">
+<pre class="src src-bash"><span style="color: #5B6268;"># </span><span style="color: #5B6268;">In dispXXXX</span>
+tar -cf /tmp/salt-archive.tar salt-repo
+</pre>
+</div>
+
+<p>
+Then, in dom0:
+</p>
+
+<div class="org-src-container">
+<pre class="src src-bash"><span style="color: #5B6268;"># </span><span style="color: #5B6268;">in dom0</span>
+<span style="color: #5B6268;"># </span><span style="color: #5B6268;">Pulls the content of the archive from dispXXXX to dom0</span>
+<span style="color: #ee7b29;">sudo</span> qvm-run --pass-io dispXXXX <span style="color: #4fb3d8;">'</span><span style="color: #4fb3d8;">cat</span><span style="color: #4fb3d8;"> /tmp/salt-archive.tar'</span> &gt; /tmp/salt-archive.tar
+
+<span style="color: #5B6268;"># </span><span style="color: #5B6268;">Unpack the archive</span>
+<span style="color: #ee7b29;">sudo</span> <span style="color: #ee7b29;">cd</span> /tmp &amp;&amp; tar -xf salt-archive.tar
+
+<span style="color: #5B6268;"># </span><span style="color: #5B6268;">Delete the default /srv/user_salt directory</span>
+<span style="color: #5B6268;"># </span><span style="color: #5B6268;">Make sure you haven't put anything important there</span>
+<span style="color: #ee7b29;">sudo</span> <span style="color: #ee7b29;">rm</span> -fr /srv/user_salt
+
+<span style="color: #5B6268;"># </span><span style="color: #5B6268;">Move the repo to /srv/user_salt</span>
+<span style="color: #ee7b29;">sudo</span> <span style="color: #ee7b29;">mv</span> /tmp/salt-repo /srv/user_salt
+</pre>
+</div>
+</div>
+</div>
+<div id="outline-container-org187ae22" class="outline-3">
+<h3 id="org187ae22">Change your username</h3>
+<div class="outline-text-3" id="text-org187ae22">
+<p>
+There&rsquo;s a variable in <i>/wm/wm-setup.sls</i> that you should change to match your username. That file needs to write files to your home directory in dom0, and needs the username for those paths.
+</p>
+</div>
+</div>
+<div id="outline-container-org5e73ac0" class="outline-3">
+<h3 id="org5e73ac0">Apply the configuration</h3>
+<div class="outline-text-3" id="text-org5e73ac0">
+<p>
+There are many directories with .sls and .top files inside of them. You can enable a feature and apply it with just a couple commands:
+</p>
+
+<div class="org-src-container">
+<pre class="src src-bash"><span style="color: #5B6268;"># </span><span style="color: #5B6268;">In dom0</span>
+<span style="color: #ee7b29;">sudo</span> qubesctl top.enable wm.wm-setup <span style="color: #5B6268;"># </span><span style="color: #5B6268;">This enables the top file at /srv/user_salt/wm/wm-setup.top</span>
+<span style="color: #ee7b29;">sudo</span> qubesctl state.apply <span style="color: #5B6268;"># </span><span style="color: #5B6268;">Applies dom0 states</span>
+<span style="color: #ee7b29;">sudo</span> qubesctl --targets=tmpl-XXXX <span style="color: #5B6268;"># </span><span style="color: #5B6268;">Applies dom0 states and states for tmpl-XXXX</span>
+</pre>
+</div>
+</div>
+</div>
+</div>
+<div id="outline-container-org0c726a0" class="outline-2">
+<h2 id="org0c726a0">Features</h2>
+<div class="outline-text-2" id="text-org0c726a0">
+</div>
+<div id="outline-container-org21ec0cc" class="outline-3">
+<h3 id="org21ec0cc">3isec</h3>
+<div class="outline-text-3" id="text-org21ec0cc">
+<p>
+Sets up the 3isec repository and graphical installer. This has lots of handy states I use for various utilities.
+</p>
+</div>
+</div>
+<div id="outline-container-orgea1b99f" class="outline-3">
+<h3 id="orgea1b99f">Chromium</h3>
+<div class="outline-text-3" id="text-orgea1b99f">
+<p>
+Creates <i>tmpl-chromium</i> and <i>web-yt</i>. I usually avoid Chromium, but YouTube performs better on it than Librewolf, so I use it for that site.
+</p>
+
+<p>
+Blueman is installed in <i>tmpl-chromium</i> so it&rsquo;s easy to pass your bluetooth controller to <i>web-yt</i> and listen with bluetooth headphones.
+</p>
+</div>
+</div>
+<div id="outline-container-org9a2e064" class="outline-3">
+<h3 id="org9a2e064">Emacs</h3>
+<div class="outline-text-3" id="text-org9a2e064">
+<p>
+Creates <i>tmpl-emacs</i> and two app qubes, <i>emacs-org</i> and <i>emacs-salt</i>, with Doom Emacs&rsquo; dependencies. I do all of my personal organization in Emacs org-mode, and <i>emacs-salt</i> is for editing my saltstack configuration.
+</p>
+
+<p>
+It also places two scripts in dom0, <i>/usr/bin/fetch-salt-from-emacs</i> and <i>/usr/bin/push-salt-to-emacs</i>. Run these as root in dom0 to easily move your repo back and forth as you please.
+</p>
+</div>
+</div>
+<div id="outline-container-orgf86d8d3" class="outline-3">
+<h3 id="orgf86d8d3">Email</h3>
+<div class="outline-text-3" id="text-orgf86d8d3">
+<p>
+Creates <i>tmpl-email</i> and two app qubes, <i>email-personal</i> and <i>email-work</i>, with Thunderbird.
+</p>
+</div>
+</div>
+<div id="outline-container-org58d03e1" class="outline-3">
+<h3 id="org58d03e1">IRC</h3>
+<div class="outline-text-3" id="text-org58d03e1">
+<p>
+Creates <i>tmpl-irc</i> and <i>irc</i> with Hexchat installed, for chatting on IRC over Tor.
+</p>
+</div>
+</div>
+<div id="outline-container-org5f413ed" class="outline-3">
+<h3 id="org5f413ed">SSH</h3>
+<div class="outline-text-3" id="text-org5f413ed">
+<p>
+Creates <i>tmpl-ssh</i> and <i>ssh-vps</i>, simple qubes to ssh into my VPS with.
+</p>
+</div>
+</div>
+<div id="outline-container-org47e978b" class="outline-3">
+<h3 id="org47e978b">Torrenting</h3>
+<div class="outline-text-3" id="text-org47e978b">
+<p>
+Creates <i>tmpl-torrenting</i> and <i>bitz</i> with qBitTorrent installed, for torrenting. Route this qube&rsquo;s traffic through a VPN if you plan on downloading anything illegal.
+</p>
+</div>
+</div>
+<div id="outline-container-orgfe754f8" class="outline-3">
+<h3 id="orgfe754f8">Web</h3>
+<div class="outline-text-3" id="text-orgfe754f8">
+<p>
+Creates <i>tmpl-web</i> and a few <i>web-XXX</i> qubes, with Librewolf.
+</p>
+</div>
+</div>
+<div id="outline-container-org621949b" class="outline-3">
+<h3 id="org621949b">WM</h3>
+<div class="outline-text-3" id="text-org621949b">
+<p>
+This does many things to set up a convenient i3 environment.
+</p>
+<ul class="org-ul">
+<li>Installs a few packages in dom0</li>
+<li>Moves my i3 config into place</li>
+<li>Prioritizes xfce4-terminal and st in <i>/usr/bin/qubes-i3-sensible-terminal</i></li>
+<li>Moves my xrandr screenlayout in place</li>
+<li>Moves my nitrogen wallpaper files in place</li>
+<li>Enables tap-to-click and natural scrolling</li>
+<li>Replaces dmenu with rofi</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div id="postamble" class="status">
+<p class="date">Created: 2024-12-19 Thu 11:15</p>
+</div>
+</body>
+</html>
author	Casper <me@skylarcloud.xyz>	2024-12-19 11:20:55 -0700
committer	Casper <me@skylarcloud.xyz>	2024-12-19 11:20:55 -0700
commit	4301b484658b8d02fd1b239bae62d0af313ff5cf (patch)
tree	4ae91c7b292eddf278c47131002e0abe906571df /README.html
parent	842303f6b1c50d303331f2122320fa960854e298 (diff)