commit bcefb9cb9f09b0271415c25d4935b44eabe8a712 · soopy.moe/gensokyo

+38

.github/workflows/build-docs.yaml

···

       1
       1
       +
       # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

     

       2
       2
       +
       permissions:

     

       3
       3
       +
         contents: read

     

       4
       4
       +
         pages: write

     

       5
       5
       +
         id-token: write

     

       6
       6
       +
       

     

       7
       7
       +
       on:

     

       8
       8
       +
         push:

     

       9
       9
       +
           branches:

     

       10
       10
       +
             - main

     

       11
       11
       +
       

     

       12
       12
       +
       jobs:

     

       13
       13
       +
       

     

       14
       14
       +
         build:

     

       15
       15
       +
           runs-on: ubuntu-latest

     

       16
       16
       +
           steps:

     

       17
       17
       +
             - uses: actions/checkout@v4

     

       18
       18
       +
             - name: Obtain mdBook

     

       19
       19
       +
               run: |

     

       20
       20
       +
                 curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.37/mdbook-v0.4.37-x86_64-unknown-linux-gnu.tar.gz | tar -xzv

     

       21
       21
       +
                 chmod +x ./mdbook

     

       22
       22
       +
             - name: Build site

     

       23
       23
       +
               run: ./mdbook build docs

     

       24
       24
       +
             - name: Upload built site as artifact

     

       25
       25
       +
               uses: actions/upload-pages-artifact@v3

     

       26
       26
       +
               with:

     

       27
       27
       +
                 path: ./docs/dist

     

       28
       28
       +
       

     

       29
       29
       +
         deploy:

     

       30
       30
       +
           environment:

     

       31
       31
       +
             name: github-pages

     

       32
       32
       +
             url: ${{ steps.deployment.outputs.page_url }}

     

       33
       33
       +
           runs-on: ubuntu-latest

     

       34
       34
       +
           needs: build

     

       35
       35
       +
           steps:

     

       36
       36
       +
             - name: Deploy to GitHub Pages

     

       37
       37
       +
               id: deployment

     

       38
       38
       +
               uses: actions/deploy-pages@v4

docs/.gitignore

···

       1
       1
       +
       dist/

-6

docs/_config.yml

···

       1
       1
       -
       remote_theme: pages-themes/leap-day@v0.2.0

     

       2
       2
       -
       plugins:

     

       3
       3
       -
       - jekyll-remote-theme # add this line to the plugins list if you already have one

     

       4
       4
       -
       

     

       5
       5
       -
       title: nix-on-koumakan

     

       6
       6
       -
       show_downloads: false

+21

docs/book.toml

···

       1
       1
       +
       [book]

     

       2
       2
       +
       authors = ["Cassie Cheung"]

     

       3
       3
       +
       language = "en"

     

       4
       4
       +
       multilingual = false

     

       5
       5
       +
       src = "src"

     

       6
       6
       +
       title = "genso-nix"

     

       7
       7
       +
       

     

       8
       8
       +
       [build]

     

       9
       9
       +
       build-dir = "./dist"

     

       10
       10
       +
       

     

       11
       11
       +
       [output.html]

     

       12
       12
       +
       preferred-dark-theme = "ayu"

     

       13
       13
       +
       git-repository-url = "https://patchy.soopy.moe/cassie/genso-nix"

     

       14
       14
       +
       git-repository-icon = "fa-code-fork"

     

       15
       15
       +
       edit-url-template = "https://patchy.soopy.moe/cassie/genso-nix/_edit/main/docs/{path}"

     

       16
       16
       +
       additional-css = ["mdbook-admonish.css"]

     

       17
       17
       +
       cname = "flake.soopy.moe"

     

       18
       18
       +
       

     

       19
       19
       +
       [preprocessor.admonish]

     

       20
       20
       +
       command = "mdbook-admonish"

     

       21
       21
       +
       assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`

-6

docs/docs.md

···

       1
       1
       -
       # documentation

     

       2
       2
       -
       lmao bals

     

       3
       3
       -
       

     

       4
       4
       -
       ## table of contents

     

       5
       5
       -
       - [tips_n_tricks.md](./tips_n_tricks.md) Tips and tricks for nix

     

       6
       6
       -
       - [utils.md](./utils.md) _utils functions reference

+1 -1

docs/ext-files.md docs/src/internal/ext-files.md

···

       1
       1
       -
       # external files not tracked by flakes

     

       1
       1
       +
       # External Untracked Files

     

       2
       2
        
       

     

       3
       3
        
       due to the required secure nature of these files, we are unable to include

     

       4
       4
        
       thses sets of files/directories in this repository.

-18

docs/index.md

···

       1
       1
       -
       # Cow

     

       2
       2
       -
       ![a yak on some grass](./quaritsch-photography-1_6rJHQ2Gmw-unsplash.jpg)

     

       3
       3
       -
       

     

       4
       4
       -
       *Gracefully provided by [Quaritsch Photography](https://unsplash.com/@quaritsch) on Unsplash, via https://unsplash.com/photos/1_6rJHQ2Gmw*

     

       5
       5
       -
       

     

       6
       6
       -
       # NixOS Configuration

     

       7
       7
       -
       This is a bare minimum nix configuration for koumakan.

     

       8
       8
       -
       

     

       9
       9
       -
       I'm still very, very new to Nix and its ecosystem so pointers to better

     

       10
       10
       -
       way of doing things are very much appreciated.

     

       11
       11
       -
       

     

       12
       12
       -
       ## docs

     

       13
       13
       -
       documentation and extra tips can be found [here](./docs)

     

       14
       14
       -
       

     

       15
       15
       -
       couldn't find what you needed? suffer with me! see the

     

       16
       16
       -
       [How 2 Nix section in this repo.](https://github.com/hlissner/dotfiles#frequently-asked-questions)

     

       17
       17
       -
       

     

       18
       18
       -
       ✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓

docs/internal/ports.md docs/src/internal/ports.md

+348

docs/mdbook-admonish.css

···

       1
       1
       +
       @charset "UTF-8";

     

       2
       2
       +
       :is(.admonition) {

     

       3
       3
       +
         display: flow-root;

     

       4
       4
       +
         margin: 1.5625em 0;

     

       5
       5
       +
         padding: 0 1.2rem;

     

       6
       6
       +
         color: var(--fg);

     

       7
       7
       +
         page-break-inside: avoid;

     

       8
       8
       +
         background-color: var(--bg);

     

       9
       9
       +
         border: 0 solid black;

     

       10
       10
       +
         border-inline-start-width: 0.4rem;

     

       11
       11
       +
         border-radius: 0.2rem;

     

       12
       12
       +
         box-shadow: 0 0.2rem 1rem rgba(0, 0, 0, 0.05), 0 0 0.1rem rgba(0, 0, 0, 0.1);

     

       13
       13
       +
       }

     

       14
       14
       +
       @media print {

     

       15
       15
       +
         :is(.admonition) {

     

       16
       16
       +
           box-shadow: none;

     

       17
       17
       +
         }

     

       18
       18
       +
       }

     

       19
       19
       +
       :is(.admonition) > * {

     

       20
       20
       +
         box-sizing: border-box;

     

       21
       21
       +
       }

     

       22
       22
       +
       :is(.admonition) :is(.admonition) {

     

       23
       23
       +
         margin-top: 1em;

     

       24
       24
       +
         margin-bottom: 1em;

     

       25
       25
       +
       }

     

       26
       26
       +
       :is(.admonition) > .tabbed-set:only-child {

     

       27
       27
       +
         margin-top: 0;

     

       28
       28
       +
       }

     

       29
       29
       +
       html :is(.admonition) > :last-child {

     

       30
       30
       +
         margin-bottom: 1.2rem;

     

       31
       31
       +
       }

     

       32
       32
       +
       

     

       33
       33
       +
       a.admonition-anchor-link {

     

       34
       34
       +
         display: none;

     

       35
       35
       +
         position: absolute;

     

       36
       36
       +
         left: -1.2rem;

     

       37
       37
       +
         padding-right: 1rem;

     

       38
       38
       +
       }

     

       39
       39
       +
       a.admonition-anchor-link:link, a.admonition-anchor-link:visited {

     

       40
       40
       +
         color: var(--fg);

     

       41
       41
       +
       }

     

       42
       42
       +
       a.admonition-anchor-link:link:hover, a.admonition-anchor-link:visited:hover {

     

       43
       43
       +
         text-decoration: none;

     

       44
       44
       +
       }

     

       45
       45
       +
       a.admonition-anchor-link::before {

     

       46
       46
       +
         content: "§";

     

       47
       47
       +
       }

     

       48
       48
       +
       

     

       49
       49
       +
       :is(.admonition-title, summary.admonition-title) {

     

       50
       50
       +
         position: relative;

     

       51
       51
       +
         min-height: 4rem;

     

       52
       52
       +
         margin-block: 0;

     

       53
       53
       +
         margin-inline: -1.6rem -1.2rem;

     

       54
       54
       +
         padding-block: 0.8rem;

     

       55
       55
       +
         padding-inline: 4.4rem 1.2rem;

     

       56
       56
       +
         font-weight: 700;

     

       57
       57
       +
         background-color: rgba(68, 138, 255, 0.1);

     

       58
       58
       +
         print-color-adjust: exact;

     

       59
       59
       +
         -webkit-print-color-adjust: exact;

     

       60
       60
       +
         display: flex;

     

       61
       61
       +
       }

     

       62
       62
       +
       :is(.admonition-title, summary.admonition-title) p {

     

       63
       63
       +
         margin: 0;

     

       64
       64
       +
       }

     

       65
       65
       +
       html :is(.admonition-title, summary.admonition-title):last-child {

     

       66
       66
       +
         margin-bottom: 0;

     

       67
       67
       +
       }

     

       68
       68
       +
       :is(.admonition-title, summary.admonition-title)::before {

     

       69
       69
       +
         position: absolute;

     

       70
       70
       +
         top: 0.625em;

     

       71
       71
       +
         inset-inline-start: 1.6rem;

     

       72
       72
       +
         width: 2rem;

     

       73
       73
       +
         height: 2rem;

     

       74
       74
       +
         background-color: #448aff;

     

       75
       75
       +
         print-color-adjust: exact;

     

       76
       76
       +
         -webkit-print-color-adjust: exact;

     

       77
       77
       +
         mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"></svg>');

     

       78
       78
       +
         -webkit-mask-image: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"></svg>');

     

       79
       79
       +
         mask-repeat: no-repeat;

     

       80
       80
       +
         -webkit-mask-repeat: no-repeat;

     

       81
       81
       +
         mask-size: contain;

     

       82
       82
       +
         -webkit-mask-size: contain;

     

       83
       83
       +
         content: "";

     

       84
       84
       +
       }

     

       85
       85
       +
       :is(.admonition-title, summary.admonition-title):hover a.admonition-anchor-link {

     

       86
       86
       +
         display: initial;

     

       87
       87
       +
       }

     

       88
       88
       +
       

     

       89
       89
       +
       details.admonition > summary.admonition-title::after {

     

       90
       90
       +
         position: absolute;

     

       91
       91
       +
         top: 0.625em;

     

       92
       92
       +
         inset-inline-end: 1.6rem;

     

       93
       93
       +
         height: 2rem;

     

       94
       94
       +
         width: 2rem;

     

       95
       95
       +
         background-color: currentcolor;

     

       96
       96
       +
         mask-image: var(--md-details-icon);

     

       97
       97
       +
         -webkit-mask-image: var(--md-details-icon);

     

       98
       98
       +
         mask-repeat: no-repeat;

     

       99
       99
       +
         -webkit-mask-repeat: no-repeat;

     

       100
       100
       +
         mask-size: contain;

     

       101
       101
       +
         -webkit-mask-size: contain;

     

       102
       102
       +
         content: "";

     

       103
       103
       +
         transform: rotate(0deg);

     

       104
       104
       +
         transition: transform 0.25s;

     

       105
       105
       +
       }

     

       106
       106
       +
       details[open].admonition > summary.admonition-title::after {

     

       107
       107
       +
         transform: rotate(90deg);

     

       108
       108
       +
       }

     

       109
       109
       +
       

     

       110
       110
       +
       :root {

     

       111
       111
       +
         --md-details-icon: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42Z'/></svg>");

     

       112
       112
       +
       }

     

       113
       113
       +
       

     

       114
       114
       +
       :root {

     

       115
       115
       +
         --md-admonition-icon--admonish-note: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z'/></svg>");

     

       116
       116
       +
         --md-admonition-icon--admonish-abstract: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17 9H7V7h10m0 6H7v-2h10m-3 6H7v-2h7M12 3a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m7 0h-4.18C14.4 1.84 13.3 1 12 1c-1.3 0-2.4.84-2.82 2H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2z'/></svg>");

     

       117
       117
       +
         --md-admonition-icon--admonish-info: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z'/></svg>");

     

       118
       118
       +
         --md-admonition-icon--admonish-tip: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M17.66 11.2c-.23-.3-.51-.56-.77-.82-.67-.6-1.43-1.03-2.07-1.66C13.33 7.26 13 4.85 13.95 3c-.95.23-1.78.75-2.49 1.32-2.59 2.08-3.61 5.75-2.39 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.23.1-.47.04-.66-.12a.58.58 0 0 1-.14-.17c-1.13-1.43-1.31-3.48-.55-5.12C5.78 10 4.87 12.3 5 14.47c.06.5.12 1 .29 1.5.14.6.41 1.2.71 1.73 1.08 1.73 2.95 2.97 4.96 3.22 2.14.27 4.43-.12 6.07-1.6 1.83-1.66 2.47-4.32 1.53-6.6l-.13-.26c-.21-.46-.77-1.26-.77-1.26m-3.16 6.3c-.28.24-.74.5-1.1.6-1.12.4-2.24-.16-2.9-.82 1.19-.28 1.9-1.16 2.11-2.05.17-.8-.15-1.46-.28-2.23-.12-.74-.1-1.37.17-2.06.19.38.39.76.63 1.06.77 1 1.98 1.44 2.24 2.8.04.14.06.28.06.43.03.82-.33 1.72-.93 2.27z'/></svg>");

     

       119
       119
       +
         --md-admonition-icon--admonish-success: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m9 20.42-6.21-6.21 2.83-2.83L9 14.77l9.88-9.89 2.83 2.83L9 20.42z'/></svg>");

     

       120
       120
       +
         --md-admonition-icon--admonish-question: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='m15.07 11.25-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 0 0-2-2 2 2 0 0 0-2 2H8a4 4 0 0 1 4-4 4 4 0 0 1 4 4 3.2 3.2 0 0 1-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10c0-5.53-4.5-10-10-10z'/></svg>");

     

       121
       121
       +
         --md-admonition-icon--admonish-warning: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2 1 21z'/></svg>");

     

       122
       122
       +
         --md-admonition-icon--admonish-failure: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M20 6.91 17.09 4 12 9.09 6.91 4 4 6.91 9.09 12 4 17.09 6.91 20 12 14.91 17.09 20 20 17.09 14.91 12 20 6.91z'/></svg>");

     

       123
       123
       +
         --md-admonition-icon--admonish-danger: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M11 15H6l7-14v8h5l-7 14v-8z'/></svg>");

     

       124
       124
       +
         --md-admonition-icon--admonish-bug: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 12h-4v-2h4m0 6h-4v-2h4m6-6h-2.81a5.985 5.985 0 0 0-1.82-1.96L17 4.41 15.59 3l-2.17 2.17a6.002 6.002 0 0 0-2.83 0L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20V8z'/></svg>");

     

       125
       125
       +
         --md-admonition-icon--admonish-example: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M7 13v-2h14v2H7m0 6v-2h14v2H7M7 7V5h14v2H7M3 8V5H2V4h2v4H3m-1 9v-1h3v4H2v-1h2v-.5H3v-1h1V17H2m2.25-7a.75.75 0 0 1 .75.75c0 .2-.08.39-.21.52L3.12 13H5v1H2v-.92L4 11H2v-1h2.25z'/></svg>");

     

       126
       126
       +
         --md-admonition-icon--admonish-quote: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M14 17h3l2-4V7h-6v6h3M6 17h3l2-4V7H5v6h3l-2 4z'/></svg>");

     

       127
       127
       +
       }

     

       128
       128
       +
       

     

       129
       129
       +
       :is(.admonition):is(.admonish-note) {

     

       130
       130
       +
         border-color: #448aff;

     

       131
       131
       +
       }

     

       132
       132
       +
       

     

       133
       133
       +
       :is(.admonish-note) > :is(.admonition-title, summary.admonition-title) {

     

       134
       134
       +
         background-color: rgba(68, 138, 255, 0.1);

     

       135
       135
       +
       }

     

       136
       136
       +
       :is(.admonish-note) > :is(.admonition-title, summary.admonition-title)::before {

     

       137
       137
       +
         background-color: #448aff;

     

       138
       138
       +
         mask-image: var(--md-admonition-icon--admonish-note);

     

       139
       139
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-note);

     

       140
       140
       +
         mask-repeat: no-repeat;

     

       141
       141
       +
         -webkit-mask-repeat: no-repeat;

     

       142
       142
       +
         mask-size: contain;

     

       143
       143
       +
         -webkit-mask-repeat: no-repeat;

     

       144
       144
       +
       }

     

       145
       145
       +
       

     

       146
       146
       +
       :is(.admonition):is(.admonish-abstract, .admonish-summary, .admonish-tldr) {

     

       147
       147
       +
         border-color: #00b0ff;

     

       148
       148
       +
       }

     

       149
       149
       +
       

     

       150
       150
       +
       :is(.admonish-abstract, .admonish-summary, .admonish-tldr) > :is(.admonition-title, summary.admonition-title) {

     

       151
       151
       +
         background-color: rgba(0, 176, 255, 0.1);

     

       152
       152
       +
       }

     

       153
       153
       +
       :is(.admonish-abstract, .admonish-summary, .admonish-tldr) > :is(.admonition-title, summary.admonition-title)::before {

     

       154
       154
       +
         background-color: #00b0ff;

     

       155
       155
       +
         mask-image: var(--md-admonition-icon--admonish-abstract);

     

       156
       156
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-abstract);

     

       157
       157
       +
         mask-repeat: no-repeat;

     

       158
       158
       +
         -webkit-mask-repeat: no-repeat;

     

       159
       159
       +
         mask-size: contain;

     

       160
       160
       +
         -webkit-mask-repeat: no-repeat;

     

       161
       161
       +
       }

     

       162
       162
       +
       

     

       163
       163
       +
       :is(.admonition):is(.admonish-info, .admonish-todo) {

     

       164
       164
       +
         border-color: #00b8d4;

     

       165
       165
       +
       }

     

       166
       166
       +
       

     

       167
       167
       +
       :is(.admonish-info, .admonish-todo) > :is(.admonition-title, summary.admonition-title) {

     

       168
       168
       +
         background-color: rgba(0, 184, 212, 0.1);

     

       169
       169
       +
       }

     

       170
       170
       +
       :is(.admonish-info, .admonish-todo) > :is(.admonition-title, summary.admonition-title)::before {

     

       171
       171
       +
         background-color: #00b8d4;

     

       172
       172
       +
         mask-image: var(--md-admonition-icon--admonish-info);

     

       173
       173
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-info);

     

       174
       174
       +
         mask-repeat: no-repeat;

     

       175
       175
       +
         -webkit-mask-repeat: no-repeat;

     

       176
       176
       +
         mask-size: contain;

     

       177
       177
       +
         -webkit-mask-repeat: no-repeat;

     

       178
       178
       +
       }

     

       179
       179
       +
       

     

       180
       180
       +
       :is(.admonition):is(.admonish-tip, .admonish-hint, .admonish-important) {

     

       181
       181
       +
         border-color: #00bfa5;

     

       182
       182
       +
       }

     

       183
       183
       +
       

     

       184
       184
       +
       :is(.admonish-tip, .admonish-hint, .admonish-important) > :is(.admonition-title, summary.admonition-title) {

     

       185
       185
       +
         background-color: rgba(0, 191, 165, 0.1);

     

       186
       186
       +
       }

     

       187
       187
       +
       :is(.admonish-tip, .admonish-hint, .admonish-important) > :is(.admonition-title, summary.admonition-title)::before {

     

       188
       188
       +
         background-color: #00bfa5;

     

       189
       189
       +
         mask-image: var(--md-admonition-icon--admonish-tip);

     

       190
       190
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-tip);

     

       191
       191
       +
         mask-repeat: no-repeat;

     

       192
       192
       +
         -webkit-mask-repeat: no-repeat;

     

       193
       193
       +
         mask-size: contain;

     

       194
       194
       +
         -webkit-mask-repeat: no-repeat;

     

       195
       195
       +
       }

     

       196
       196
       +
       

     

       197
       197
       +
       :is(.admonition):is(.admonish-success, .admonish-check, .admonish-done) {

     

       198
       198
       +
         border-color: #00c853;

     

       199
       199
       +
       }

     

       200
       200
       +
       

     

       201
       201
       +
       :is(.admonish-success, .admonish-check, .admonish-done) > :is(.admonition-title, summary.admonition-title) {

     

       202
       202
       +
         background-color: rgba(0, 200, 83, 0.1);

     

       203
       203
       +
       }

     

       204
       204
       +
       :is(.admonish-success, .admonish-check, .admonish-done) > :is(.admonition-title, summary.admonition-title)::before {

     

       205
       205
       +
         background-color: #00c853;

     

       206
       206
       +
         mask-image: var(--md-admonition-icon--admonish-success);

     

       207
       207
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-success);

     

       208
       208
       +
         mask-repeat: no-repeat;

     

       209
       209
       +
         -webkit-mask-repeat: no-repeat;

     

       210
       210
       +
         mask-size: contain;

     

       211
       211
       +
         -webkit-mask-repeat: no-repeat;

     

       212
       212
       +
       }

     

       213
       213
       +
       

     

       214
       214
       +
       :is(.admonition):is(.admonish-question, .admonish-help, .admonish-faq) {

     

       215
       215
       +
         border-color: #64dd17;

     

       216
       216
       +
       }

     

       217
       217
       +
       

     

       218
       218
       +
       :is(.admonish-question, .admonish-help, .admonish-faq) > :is(.admonition-title, summary.admonition-title) {

     

       219
       219
       +
         background-color: rgba(100, 221, 23, 0.1);

     

       220
       220
       +
       }

     

       221
       221
       +
       :is(.admonish-question, .admonish-help, .admonish-faq) > :is(.admonition-title, summary.admonition-title)::before {

     

       222
       222
       +
         background-color: #64dd17;

     

       223
       223
       +
         mask-image: var(--md-admonition-icon--admonish-question);

     

       224
       224
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-question);

     

       225
       225
       +
         mask-repeat: no-repeat;

     

       226
       226
       +
         -webkit-mask-repeat: no-repeat;

     

       227
       227
       +
         mask-size: contain;

     

       228
       228
       +
         -webkit-mask-repeat: no-repeat;

     

       229
       229
       +
       }

     

       230
       230
       +
       

     

       231
       231
       +
       :is(.admonition):is(.admonish-warning, .admonish-caution, .admonish-attention) {

     

       232
       232
       +
         border-color: #ff9100;

     

       233
       233
       +
       }

     

       234
       234
       +
       

     

       235
       235
       +
       :is(.admonish-warning, .admonish-caution, .admonish-attention) > :is(.admonition-title, summary.admonition-title) {

     

       236
       236
       +
         background-color: rgba(255, 145, 0, 0.1);

     

       237
       237
       +
       }

     

       238
       238
       +
       :is(.admonish-warning, .admonish-caution, .admonish-attention) > :is(.admonition-title, summary.admonition-title)::before {

     

       239
       239
       +
         background-color: #ff9100;

     

       240
       240
       +
         mask-image: var(--md-admonition-icon--admonish-warning);

     

       241
       241
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-warning);

     

       242
       242
       +
         mask-repeat: no-repeat;

     

       243
       243
       +
         -webkit-mask-repeat: no-repeat;

     

       244
       244
       +
         mask-size: contain;

     

       245
       245
       +
         -webkit-mask-repeat: no-repeat;

     

       246
       246
       +
       }

     

       247
       247
       +
       

     

       248
       248
       +
       :is(.admonition):is(.admonish-failure, .admonish-fail, .admonish-missing) {

     

       249
       249
       +
         border-color: #ff5252;

     

       250
       250
       +
       }

     

       251
       251
       +
       

     

       252
       252
       +
       :is(.admonish-failure, .admonish-fail, .admonish-missing) > :is(.admonition-title, summary.admonition-title) {

     

       253
       253
       +
         background-color: rgba(255, 82, 82, 0.1);

     

       254
       254
       +
       }

     

       255
       255
       +
       :is(.admonish-failure, .admonish-fail, .admonish-missing) > :is(.admonition-title, summary.admonition-title)::before {

     

       256
       256
       +
         background-color: #ff5252;

     

       257
       257
       +
         mask-image: var(--md-admonition-icon--admonish-failure);

     

       258
       258
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-failure);

     

       259
       259
       +
         mask-repeat: no-repeat;

     

       260
       260
       +
         -webkit-mask-repeat: no-repeat;

     

       261
       261
       +
         mask-size: contain;

     

       262
       262
       +
         -webkit-mask-repeat: no-repeat;

     

       263
       263
       +
       }

     

       264
       264
       +
       

     

       265
       265
       +
       :is(.admonition):is(.admonish-danger, .admonish-error) {

     

       266
       266
       +
         border-color: #ff1744;

     

       267
       267
       +
       }

     

       268
       268
       +
       

     

       269
       269
       +
       :is(.admonish-danger, .admonish-error) > :is(.admonition-title, summary.admonition-title) {

     

       270
       270
       +
         background-color: rgba(255, 23, 68, 0.1);

     

       271
       271
       +
       }

     

       272
       272
       +
       :is(.admonish-danger, .admonish-error) > :is(.admonition-title, summary.admonition-title)::before {

     

       273
       273
       +
         background-color: #ff1744;

     

       274
       274
       +
         mask-image: var(--md-admonition-icon--admonish-danger);

     

       275
       275
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-danger);

     

       276
       276
       +
         mask-repeat: no-repeat;

     

       277
       277
       +
         -webkit-mask-repeat: no-repeat;

     

       278
       278
       +
         mask-size: contain;

     

       279
       279
       +
         -webkit-mask-repeat: no-repeat;

     

       280
       280
       +
       }

     

       281
       281
       +
       

     

       282
       282
       +
       :is(.admonition):is(.admonish-bug) {

     

       283
       283
       +
         border-color: #f50057;

     

       284
       284
       +
       }

     

       285
       285
       +
       

     

       286
       286
       +
       :is(.admonish-bug) > :is(.admonition-title, summary.admonition-title) {

     

       287
       287
       +
         background-color: rgba(245, 0, 87, 0.1);

     

       288
       288
       +
       }

     

       289
       289
       +
       :is(.admonish-bug) > :is(.admonition-title, summary.admonition-title)::before {

     

       290
       290
       +
         background-color: #f50057;

     

       291
       291
       +
         mask-image: var(--md-admonition-icon--admonish-bug);

     

       292
       292
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-bug);

     

       293
       293
       +
         mask-repeat: no-repeat;

     

       294
       294
       +
         -webkit-mask-repeat: no-repeat;

     

       295
       295
       +
         mask-size: contain;

     

       296
       296
       +
         -webkit-mask-repeat: no-repeat;

     

       297
       297
       +
       }

     

       298
       298
       +
       

     

       299
       299
       +
       :is(.admonition):is(.admonish-example) {

     

       300
       300
       +
         border-color: #7c4dff;

     

       301
       301
       +
       }

     

       302
       302
       +
       

     

       303
       303
       +
       :is(.admonish-example) > :is(.admonition-title, summary.admonition-title) {

     

       304
       304
       +
         background-color: rgba(124, 77, 255, 0.1);

     

       305
       305
       +
       }

     

       306
       306
       +
       :is(.admonish-example) > :is(.admonition-title, summary.admonition-title)::before {

     

       307
       307
       +
         background-color: #7c4dff;

     

       308
       308
       +
         mask-image: var(--md-admonition-icon--admonish-example);

     

       309
       309
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-example);

     

       310
       310
       +
         mask-repeat: no-repeat;

     

       311
       311
       +
         -webkit-mask-repeat: no-repeat;

     

       312
       312
       +
         mask-size: contain;

     

       313
       313
       +
         -webkit-mask-repeat: no-repeat;

     

       314
       314
       +
       }

     

       315
       315
       +
       

     

       316
       316
       +
       :is(.admonition):is(.admonish-quote, .admonish-cite) {

     

       317
       317
       +
         border-color: #9e9e9e;

     

       318
       318
       +
       }

     

       319
       319
       +
       

     

       320
       320
       +
       :is(.admonish-quote, .admonish-cite) > :is(.admonition-title, summary.admonition-title) {

     

       321
       321
       +
         background-color: rgba(158, 158, 158, 0.1);

     

       322
       322
       +
       }

     

       323
       323
       +
       :is(.admonish-quote, .admonish-cite) > :is(.admonition-title, summary.admonition-title)::before {

     

       324
       324
       +
         background-color: #9e9e9e;

     

       325
       325
       +
         mask-image: var(--md-admonition-icon--admonish-quote);

     

       326
       326
       +
         -webkit-mask-image: var(--md-admonition-icon--admonish-quote);

     

       327
       327
       +
         mask-repeat: no-repeat;

     

       328
       328
       +
         -webkit-mask-repeat: no-repeat;

     

       329
       329
       +
         mask-size: contain;

     

       330
       330
       +
         -webkit-mask-repeat: no-repeat;

     

       331
       331
       +
       }

     

       332
       332
       +
       

     

       333
       333
       +
       .navy :is(.admonition) {

     

       334
       334
       +
         background-color: var(--sidebar-bg);

     

       335
       335
       +
       }

     

       336
       336
       +
       

     

       337
       337
       +
       .ayu :is(.admonition),

     

       338
       338
       +
       .coal :is(.admonition) {

     

       339
       339
       +
         background-color: var(--theme-hover);

     

       340
       340
       +
       }

     

       341
       341
       +
       

     

       342
       342
       +
       .rust :is(.admonition) {

     

       343
       343
       +
         background-color: var(--sidebar-bg);

     

       344
       344
       +
         color: var(--sidebar-fg);

     

       345
       345
       +
       }

     

       346
       346
       +
       .rust .admonition-anchor-link:link, .rust .admonition-anchor-link:visited {

     

       347
       347
       +
         color: var(--sidebar-fg);

     

       348
       348
       +
       }

docs/quaritsch-photography-1_6rJHQ2Gmw-unsplash.jpg docs/src/images/quaritsch-photography-1_6rJHQ2Gmw-unsplash.jpg

+24

docs/src/README.md

···

       1
       1
       +
       # Cow

     

       2
       2
       +
       ![a yak on some grass](./images/quaritsch-photography-1_6rJHQ2Gmw-unsplash.jpg)

     

       3
       3
       +
       

     

       4
       4
       +
       *Gracefully provided by [Quaritsch Photography](https://unsplash.com/@quaritsch) on Unsplash, via

     

       5
       5
       +
       https://unsplash.com/photos/1_6rJHQ2Gmw*

     

       6
       6
       +
       

     

       7
       7
       +
       # NixOS Configuration

     

       8
       8
       +
       This is a bare minimum nix configuration for koumakan.

     

       9
       9
       +
       

     

       10
       10
       +
       I'm still very, very new to Nix and its ecosystem so pointers to better

     

       11
       11
       +
       way of doing things are very much appreciated.

     

       12
       12
       +
       

     

       13
       13
       +
       The canonical URL of this site is <https://flake.soopy.moe>.

     

       14
       14
       +
       

     

       15
       15
       +
       ## Documentation

     

       16
       16
       +
       Documentation and other tips can be found in this book. See the sidebar on the left for a table of contents.

     

       17
       17
       +
       

     

       18
       18
       +
       couldn't find what you needed? suffer with me! see the

     

       19
       19
       +
       [How 2 Nix section in this repo.](https://github.com/hlissner/dotfiles#frequently-asked-questions)

     

       20
       20
       +
       

     

       21
       21
       +
       <div class="center" style="margin: auto; text-align: center;">

     

       22
       22
       +
         <p>✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓</p>

     

       23
       23
       +
         <img src="./images/xeniatrans.gif" alt="A 88x31 pixel art button of Xenia, a proposed mascot for the Linux. On the left is a square portrait of Xenia, with the transgender flag as the background. To the right is the text Linux NOW!." title="Trans rights" />

     

       24
       24
       +
       </div>

+23

docs/src/SUMMARY.md

···

       1
       1
       +
       # Summary

     

       2
       2
       +
       [Welcome to the Cow](README.md)

     

       3
       3
       +
       

     

       4
       4
       +
       # Documentation

     

       5
       5
       +
       - [Tips and Tricks](./tips/README.md)

     

       6
       6
       +
         - [Overriding packages](./tips/overriding-packages.md)

     

       7
       7
       +
         - [Overlays](./tips/overlays.md)

     

       8
       8
       +
         - ["Global" Options](./tips/global-options.md)

     

       9
       9
       +
         - [Passing large secrets to DynamicUser=true services](./tips/pass-big-secrets-to-dynamic-user.md)

     

       10
       10
       +
         - [Miscellaneous Tips](./tips/misc.md)

     

       11
       11
       +
         - [Pitfalls](./tips/pitfalls.md)

     

       12
       12
       +
       - [Utility Functions](./utils/README.md)

     

       13
       13
       +
         - [mkVhost](./utils/mkVhost.md)

     

       14
       14
       +
         - [mkSimpleProxy](./utils/mkSimpleProxy.md)

     

       15
       15
       +
         - [genSecrets](./utils/genSecrets.md)

     

       16
       16
       +
         - [setupSecrets](./utils/setupSecrets.md)

     

       17
       17
       +
         - [mkNginxFile](./utils/mkNginxFile.md)

     

       18
       18
       +
         - [mkNginxJSON](./utils/mkNginxJSON.md)

     

       19
       19
       +
       

     

       20
       20
       +
       # Internal documentation

     

       21
       21
       +
       - ["Private" use]()

     

       22
       22
       +
         - [Ports](./internal/ports.md)

     

       23
       23
       +
         - [External Untracked Files](./internal/ext-files.md)

docs/src/images/xeniatrans.gif

This is a binary file and will not be displayed.

+14

docs/src/tips/README.md

···

       1
       1
       +
       # Tips and Tricks

     

       2
       2
       +
       *formerly known as tops and bottoms*

     

       3
       3
       +
       

     

       4
       4
       +
       This section outlines things that I've learned from various sources and some pure guesswork.

     

       5
       5
       +
       

     

       6
       6
       +
       > To learn Nix is to learn to suffer, and to learn the way of numbing the pain

     

       7
       7
       +
       >

     

       8
       8
       +
       > *— Cassie circa. 2023*

     

       9
       9
       +
       

     

       10
       10
       +
       There might be more undocumented things. Interesting things are usually marked with `#‍ HACK:`.

     

       11
       11
       +
       

     

       12
       12
       +
       Of course, I might completely miss stuff. in that case, feel free to open an issue.

     

       13
       13
       +
       

     

       14
       14
       +
       To get started, look at the sidebar to the left.

+41

docs/src/tips/global-options.md

···

       1
       1
       +
       # "Global"/Extra Options

     

       2
       2
       +
       a way of passing additional options "globally" to modules is by using extraOpts.

     

       3
       3
       +
       

     

       4
       4
       +
       in nix flakes, this is accomplished by using `specialArgs` in `nixosSystem`.

     

       5
       5
       +
       

     

       6
       6
       +
       for example, check out these few lines in our flake.nix: [[source]](https://github.com/soopyc/nix-on-koumakan/blob/492dfaa01808c2aa5dbb2d8223163e92bcef673b/flake.nix#L29-L34)

     

       7
       7
       +
       

     

       8
       8
       +
       ```nix

     

       9
       9
       +
       # note: unrelated attributes stripped and removed.

     

       10
       10
       +
       # note2: this code is now out of date from our code, but can still be referenced.

     

       11
       11
       +
       {

     

       12
       12
       +
         outputs = { ... }:{

     

       13
       13
       +
           nixosConfigurations = {

     

       14
       14
       +
             koumakan = lib.nixosSystem {

     

       15
       15
       +
               specialArgs = {

     

       16
       16
       +
                 _utils = (import ./global/utils.nix) { inherit pkgs; };

     

       17
       17
       +
       

     

       18
       18
       +
                 someOtherArg = {thisCanBe = "LiterallyAnything";};

     

       19
       19
       +
               };

     

       20
       20
       +
             };

     

       21
       21
       +
           };

     

       22
       22
       +
         };

     

       23
       23
       +
       }

     

       24
       24
       +
       ```

     

       25
       25
       +
       

     

       26
       26
       +
       With this, you can now do this in other imported nixos modules.

     

       27
       27
       +
       

     

       28
       28
       +
       ```nix

     

       29
       29
       +
       { someOtherArg, ... }: {

     

       30
       30
       +
         users.users.${someOtherArg} = {};

     

       31
       31
       +
       }

     

       32
       32
       +
       ```

     

       33
       33
       +
       

     

       34
       34
       +
       this avoids the horror of `import ../../../utils/bar.nix;` and various other things.

     

       35
       35
       +
       

     

       36
       36
       +
       refer to [nixpkgs:nixos/lib/eval-config.nix] and [nixpkgs:lib/modules.nix#122] for more info

     

       37
       37
       +
       

     

       38
       38
       +
       *pointers by \@natsukagami*

     

       39
       39
       +
       

     

       40
       40
       +
       [nixpkgs:lib/modules.nix#122]: https://github.com/NixOS/nixpkgs/blob/6e68daefde56a7a8e6fe7c3ca9ceeb436294bb9f/lib/modules.nix#L122

     

       41
       41
       +
       [nixpkgs:nixos/lib/eval-config.nix]: https://github.com/NixOS/nixpkgs/blob/5054472759a3b0df8e18cfe4031a5eff92d4cdc3/nixos/lib/eval-config.nix

+51

docs/src/tips/misc.md

···

       1
       1
       +
       # Misc tips

     

       2
       2
       +
       

     

       3
       3
       +
       This page contains stuff that ~~I couldn't be bothered to move to the new format~~ is probably outdated or just short tips.

     

       4
       4
       +
       

     

       5
       5
       +
       *previously: tops and bottoms*

     

       6
       6
       +
       

     

       7
       7
       +
       ## @ (at) syntax

     

       8
       8
       +
       very simple.

     

       9
       9
       +
       

     

       10
       10
       +
       ```nix

     

       11
       11
       +
       args@{a, b, c, ...}: {

     

       12
       12
       +
         # args.a and a are the same

     

       13
       13
       +
         some = "value";

     

       14
       14
       +
       }

     

       15
       15
       +
       ```

     

       16
       16
       +
       

     

       17
       17
       +
       ## nginx regex location

     

       18
       18
       +
       ```nix

     

       19
       19
       +
       {

     

       20
       20
       +
         locations."~ \.php$".extraConfig = ''

     

       21
       21
       +
           # balls

     

       22
       22
       +
         '';

     

       23
       23
       +
       }

     

       24
       24
       +
       ```

     

       25
       25
       +
       from [nixos wiki](https://nixos.wiki/wiki/Nginx#LEMP_stack)

     

       26
       26
       +
       

     

       27
       27
       +
       ## adding a package with an overlay to a package set

     

       28
       28
       +
       

     

       29
       29
       +
       for package sets with a scope, you will have to do something like

     

       30
       30
       +
       ```nix

     

       31
       31
       +
       final: prev: {

     

       32
       32
       +
         nimPackages = prev.nimPackages.overrideScope (final': prev': {

     

       33
       33
       +
           sha1 = final'.callPackage ./sha1.nix {};

     

       34
       34
       +
           oauth = final'.callPackage ./oauth.nix {};

     

       35
       35
       +
         });

     

       36
       36
       +
       }

     

       37
       37
       +
       ```

     

       38
       38
       +
       There's an alternative method that i used to use here:

     

       39
       39
       +
       

     

       40
       40
       +
       https://github.com/soopyc/nix-on-koumakan/blob/30e65402d22b000a3b5af6c9e5ea48a2b58a54e0/overlays/nim/oauth/default.nix

     

       41
       41
       +
       

     

       42
       42
       +
       however i do not think that's the best way lol

     

       43
       43
       +
       

     

       44
       44
       +
       ## what the hell is an IFD??

     

       45
       45
       +
       IFD stands for import from derivation.

     

       46
       46
       +
       

     

       47
       47
       +
       *nixos/nixpkgs really need better and significantly less scattered documentation while improving manual readability.*

     

       48
       48
       +
       

     

       49
       49
       +
       # Useful links

     

       50
       50
       +
       

     

       51
       51
       +
       Builtin stdlib functions search engine: https://noogle.dev/

+33

docs/src/tips/overlays.md

···

       1
       1
       +
       # Overlays

     

       2
       2
       +
       overlays are useful when you want to refer to a package globally, or to fix a broken package locally.

     

       3
       3
       +
       

     

       4
       4
       +
       you might also want to use overlays when something hasn't made it into nixos-unstable or whatever you're on yet, but you

     

       5
       5
       +
       desparately need said thing.

     

       6
       6
       +
       

     

       7
       7
       +
       the gist of overlays is as thus:

     

       8
       8
       +
       

     

       9
       9
       +
       > overlay is just `final: prev: {}` functions

     

       10
       10
       +
       >

     

       11
       11
       +
       > dumbed down idea is that you do `pkg = prev.pkg.override` and

     

       12
       12
       +
       > refer to everything else from `final`

     

       13
       13
       +
       >

     

       14
       14
       +
       > idea is like final = prev // overlay(prev, final)

     

       15
       15
       +
       >

     

       16
       16
       +
       > (it's a recursive definition)

     

       17
       17
       +
       

     

       18
       18
       +
       (poorly made) example overlays can be found [here](https://github.com/soopyc/nixos-config/blob/master/overlays/discord-canary.nix)

     

       19
       19
       +
       

     

       20
       20
       +
       ~~currently in-use and slightly better overlays can be found in this repo! head over to /overlays to see them.~~

     

       21
       21
       +
       

     

       22
       22
       +
       *note: replace `self: super:` with `final: prev:` for consistency*

     

       23
       23
       +
       

     

       24
       24
       +
       UPDATE: we don't really use overlays anymore. If you'd like an example, please reach out and we can add some here.

     

       25
       25
       +
       

     

       26
       26
       +
       *concept and quote content by @natsukagami*

     

       27
       27
       +
       

     

       28
       28
       +
       ```admonish info

     

       29
       29
       +
       If you write 3rd party nix modules, it is a bad idea to do overlays as the performance impact propagates to everyone

     

       30
       30
       +
       in the stream. See [this article that talks about overlays](

     

       31
       31
       +
       	https://zimbatm.com/notes/1000-instances-of-nixpkgs

     

       32
       32
       +
       ).

     

       33
       33
       +
       ```

+16

docs/src/tips/overriding-packages.md

···

       1
       1
       +
       # Overriding Packages

     

       2
       2
       +
       The nix pill confused me and i thought i had to make overlays to do overrides but no

     

       3
       3
       +
       

     

       4
       4
       +
       in packages (i.e. `environment.systemPackages`), just do

     

       5
       5
       +
       ```nix

     

       6
       6
       +
       {pkgs, ...}: {

     

       7
       7
       +
         environment.systemPackages = with pkgs; [

     

       8
       8
       +
           (discord.override {withOpenASAR = true;})

     

       9
       9
       +
         ];

     

       10
       10
       +
       }

     

       11
       11
       +
       ```

     

       12
       12
       +
       

     

       13
       13
       +
       This works as well

     

       14
       14
       +
       ```nix

     

       15
       15
       +
       security.sudo.package = (pkgs.sudo.override {withInsults = true;});

     

       16
       16
       +
       ```

+78

docs/src/tips/pass-big-secrets-to-dynamic-user.md

···

       1
       1
       +
       <!--

     

       2
       2
       +
         vim:fileencoding=utf-8:foldmethod=marker

     

       3
       3
       +
       -->

     

       4
       4
       +
       

     

       5
       5
       +
       ## using sops-nix or other stuff to pass big chungus files to services with DynamicUser=true

     

       6
       6
       +
       

     

       7
       7
       +
       afaik this is not possible.

     

       8
       8
       +
       

     

       9
       9
       +
       The option that makes the most sense, LoadCredentials only supports files up to 1 MB in size.

     

       10
       10
       +
       ([relevant documentation (`systemd.exec(5)`)](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#LoadCredential=ID:PATH:~:text=Currently%2C%20an,is%20enforced))

     

       11
       11
       +
       

     

       12
       12
       +
       Without that option, we are only left with giving a user access to the file somehow.

     

       13
       13
       +
       

     

       14
       14
       +
       Doing that directly via systemd is not possible either. We cannot get the dynamic user's id in a ExecStartPre hook with the `+` prefix to `chown` the file.

     

       15
       15
       +
       The user is ran with root privileges and there are no signs of the final ephemeral user id. the same happens with

     

       16
       16
       +
       ones prefixed with `!`.

     

       17
       17
       +
       

     

       18
       18
       +
       ```admonish note

     

       19
       19
       +
       While the `!` syntax do preallocate a dynamic user, we cannot use it to change any permissions. (at least per my last attempt)

     

       20
       20
       +
       ```

     

       21
       21
       +
       

     

       22
       22
       +
       <!--

     

       23
       23
       +
         This is a vim fold. press z+o to open, z+c to close.

     

       24
       24
       +
         Terminal output {{{

     

       25
       25
       +
       -->

     

       26
       26
       +
       ~~~admonish tldr title="Terminal Output" collapsible=true

     

       27
       27
       +
       ```console

     

       28
       28
       +
       cassie in marisa in ~ took 1s

     

       29
       29
       +
       ✗ 1 ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true --property="SystemCallFilter=@system-service ~@privileged ~@resources" -pExecStartPre="+env" -pPrivateUsers=true -t bash

     

       30
       30
       +
       

     

       31
       31
       +
       Running as unit: run-u1196.service

     

       32
       32
       +
       Press ^] three times within 1s to disconnect TTY.

     

       33
       33
       +
       LANG=en_US.UTF-8

     

       34
       34
       +
       PATH=/usr/local/sbin:/usr/local/bin:/usr/bin

     

       35
       35
       +
       LOGNAME=run-u1196

     

       36
       36
       +
       USER=run-u1196

     

       37
       37
       +
       [...]

     

       38
       38
       +
       ^C%

     

       39
       39
       +
       

     

       40
       40
       +
       cassie in marisa in ~ took 2s

     

       41
       41
       +
       ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true --property="SystemCallFilter=@system-service ~@privileged ~@resources" -pExecStartPre="\!env" -pPrivateUsers=true -t bash

     

       42
       42
       +
       

     

       43
       43
       +
       Running as unit: run-u1200.service

     

       44
       44
       +
       Press ^] three times within 1s to disconnect TTY.

     

       45
       45
       +
       LANG=en_US.UTF-8

     

       46
       46
       +
       PATH=/usr/local/sbin:/usr/local/bin:/usr/bin

     

       47
       47
       +
       LOGNAME=run-u1200

     

       48
       48
       +
       USER=run-u1200

     

       49
       49
       +
       [...]

     

       50
       50
       +
       ^C%

     

       51
       51
       +
       

     

       52
       52
       +
       cassie in marisa in ~ took 2s

     

       53
       53
       +
       ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true -pSystemCallFilter=@system-service -pSystemCallFilter=~@privileged -pSystemCallFilter=~@resources -pExecStartPre="\!bash -c 'echo \$UID'" -pPrivateUsers=true -t bash -c "ls"

     

       54
       54
       +
       

     

       55
       55
       +
       Running as unit: run-u1236.service

     

       56
       56
       +
       Press ^] three times within 1s to disconnect TTY.

     

       57
       57
       +
       0

     

       58
       58
       +
       ^C%

     

       59
       59
       +
       

     

       60
       60
       +
       cassie in marisa in ~ took 4s

     

       61
       61
       +
       ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true -pSystemCallFilter=@system-service -pSystemCallFilter=~@privileged -pSystemCallFilter=~@resources -pExecStartPre="+bash -c 'echo \$UID'" -pPrivateUsers=true -t bash -c "ls"

     

       62
       62
       +
       

     

       63
       63
       +
       Running as unit: run-u1241.service

     

       64
       64
       +
       Press ^] three times within 1s to disconnect TTY.

     

       65
       65
       +
       0

     

       66
       66
       +
       ^C%

     

       67
       67
       +
       ```

     

       68
       68
       +
       ~~~

     

       69
       69
       +
       <!--

     

       70
       70
       +
         }}}

     

       71
       71
       +
       -->

     

       72
       72
       +
       

     

       73
       73
       +
       So now, we are left with the only option, which is to create a non-ephemeral user, assign it to the unit and disable DynamicUser.

     

       74
       74
       +
       This step is a little involved, you will have to add a user option to the service and forcibly disable DynamicUser.

     

       75
       75
       +
       

     

       76
       76
       +
       I opted to replace the entire module file with my own under a different name, as I had to fix a mistake in it anyways.

     

       77
       77
       +
       Here's the link to [the modified source file.](https://github.com/soopyc/mystia/blob/a999736/modules/fixups/nitter.nix)

     

       78
       78
       +
       For clarity's sake, [this is the diff of the changes made.](https://github.com/soopyc/mystia/compare/3be5eef..a999736)

+64

docs/src/tips/pitfalls.md

···

       1
       1
       +
       # Pitfalls

     

       2
       2
       +
       

     

       3
       3
       +
       "There are pitfalls in this language???!??!?"

     

       4
       4
       +
       

     

       5
       5
       +
       *-- The uninitiated*

     

       6
       6
       +
       

     

       7
       7
       +
       ## importing nixpkgs with an empty attrset

     

       8
       8
       +
       

     

       9
       9
       +
       ever had this in your flake.nix

     

       10
       10
       +
       

     

       11
       11
       +
       ```nix

     

       12
       12
       +
       {

     

       13
       13
       +
         outputs = { nixpkgs, ... }@inputs: let

     

       14
       14
       +
           pkgs = import nixpkgs {};

     

       15
       15
       +
           lib = nixpkgs.lib;

     

       16
       16
       +
         in {

     

       17
       17
       +
           # ...

     

       18
       18
       +
         };

     

       19
       19
       +
       }

     

       20
       20
       +
       ```

     

       21
       21
       +
       

     

       22
       22
       +
       ... and got fucked with this?

     

       23
       23
       +
       ```shell

     

       24
       24
       +
       error:

     

       25
       25
       +
              … while checking flake output 'nixosConfigurations'

     

       26
       26
       +
       

     

       27
       27
       +
                at /nix/store/lz2ra1180qfffmpwg41jpyg1z602qdgx-source/flake.nix:50:5:

     

       28
       28
       +
       

     

       29
       29
       +
                  49|   in {

     

       30
       30
       +
                  50|     nixosConfigurations = {

     

       31
       31
       +
                    |     ^

     

       32
       32
       +
                  51|       koumakan = (import ./systems/koumakan { inherit pkgs lib inputs; });

     

       33
       33
       +
       

     

       34
       34
       +
              … while checking the NixOS configuration 'nixosConfigurations.koumakan'

     

       35
       35
       +
       

     

       36
       36
       +
                at /nix/store/lz2ra1180qfffmpwg41jpyg1z602qdgx-source/flake.nix:51:7:

     

       37
       37
       +
       

     

       38
       38
       +
                  50|     nixosConfigurations = {

     

       39
       39
       +
                  51|       koumakan = (import ./systems/koumakan { inherit pkgs lib inputs; });

     

       40
       40
       +
                    |       ^

     

       41
       41
       +
                  52|     };

     

       42
       42
       +
       

     

       43
       43
       +
              (stack trace truncated; use '--show-trace' to show the full trace)

     

       44
       44
       +
       

     

       45
       45
       +
              error: attribute 'currentSystem' missing

     

       46
       46
       +
       

     

       47
       47
       +
              at /nix/store/5c0k827yjq7j24qaq8l2fcnsxp7nv8v1-source/pkgs/top-level/impure.nix:17:43:

     

       48
       48
       +
       

     

       49
       49
       +
                  16|   # (build, in GNU Autotools parlance) platform.

     

       50
       50
       +
                  17|   localSystem ? { system = args.system or builtins.currentSystem; }

     

       51
       51
       +
                    |                                           ^

     

       52
       52
       +
                  18|

     

       53
       53
       +
       ```

     

       54
       54
       +
       

     

       55
       55
       +
       just don't!!!11 remove the pkgs definition. (note that this only applies to `pkgs = import nixpkgs {};`)

     

       56
       56
       +
       

     

       57
       57
       +
       explanation

     

       58
       58
       +
       

     

       59
       59
       +
       > you shouldn't ever really import nixpkgs with an empty attrset either

     

       60
       60
       +
       >

     

       61
       61
       +
       > that causes it to fall back on guessing your system using `builtins.currentSystem`,

     

       62
       62
       +
       > which is impure and so not allowed in pure evaluation mode

     

       63
       63
       +
       >

     

       64
       64
       +
       > —- @getchoo

+32

docs/src/utils/README.md

···

       1
       1
       +
       # Utility Functions

     

       2
       2
       +
       

     

       3
       3
       +
       In this section you will find various utility functions available in this flake.

     

       4
       4
       +
       

     

       5
       5
       +
       You are free to use them as you wish if you find them useful.

     

       6
       6
       +
       

     

       7
       7
       +
       Watch out! Here's a hint box!

     

       8
       8
       +
       

     

       9
       9
       +
       ```admonish hint title="Hint Box"

     

       10
       10
       +
       Please take care when using these functions. They are opinionated by nature and are designed to be used on our systems.

     

       11
       11
       +
       

     

       12
       12
       +
       There is a high chance for you to be discontent with them. In which case, please feel free to copy them and adapt them

     

       13
       13
       +
       to your needs.

     

       14
       14
       +
       

     

       15
       15
       +
       Also what in the world? Is that discrimination against hint boxes? I demand this be rectified immediately!

     

       16
       16
       +
       ```

     

       17
       17
       +
       

     

       18
       18
       +
       ## Getting started

     

       19
       19
       +
       You first need to import this flake as an input.

     

       20
       20
       +
       

     

       21
       21
       +
       If you don't know how to do so, you should not be here. Please refer to various Nix documentation first, then come back.

     

       22
       22
       +
       Using these utilities when you're just starting out causes unnecessary pain later on when it doesn't match your needs.

     

       23
       23
       +
       

     

       24
       24
       +
       For NixOS users, it is possible to make the utils module "globally" available in your NixOS configuration modules.

     

       25
       25
       +
       To do so, please refer to [Tips/"Global" Options](../tips/global-options.md).

     

       26
       26
       +
       

     

       27
       27
       +
       We are dogfooding on these functions ourselves so they should be relatively error-free. If you encounter unexpected

     

       28
       28
       +
       behavior though, do reach out and open an issue/send us a message. We won't bite. Promise.

     

       29
       29
       +
       

     

       30
       30
       +
       ```admonish hint title="Hint Box"

     

       31
       31
       +
       Hey! Are you even listening?

     

       32
       32
       +
       ```

+29

docs/src/utils/genSecrets.md

···

       1
       1
       +
       # `_utils.genSecrets`

     

       2
       2
       +
       `namespace<str> -> files<list[str]> -> value<attrset> -> attrset`

     

       3
       3
       +
       

     

       4
       4
       +
       ```admonish danger

     

       5
       5
       +
       This function is now an internal function. The signature is not likely to be changed, but there are better utilities to

     

       6
       6
       +
       do the job even better. Consider using [`setupSecrets`](./setupSecrets.md) instead.

     

       7
       7
       +
       ```

     

       8
       8
       +
       

     

       9
       9
       +
       generate an attrset to be passed into sops.secrets.

     

       10
       10
       +
       

     

       11
       11
       +
       ## Example

     

       12
       12
       +
       ```nix

     

       13
       13
       +
       { _utils, ... }:

     

       14
       14
       +
       let

     

       15
       15
       +
         secrets = [

     

       16
       16
       +
           "secure_secret"

     

       17
       17
       +
           # this is a directory structure, so secrets will be stored as a file in /run/secrets/service/test/secret.

     

       18
       18
       +
           "service/test/secret"

     

       19
       19
       +
         ];

     

       20
       20
       +
       in {

     

       21
       21
       +
         sops.secrets = _utils.genSecrets "" secrets {}; # it's recommended to use a namespace, but having none is still fine.

     

       22
       22
       +
         # -> sops.secrets."secure_secret" = {};

     

       23
       23
       +
         #    sops.secrets."service/test/secret" = {};

     

       24
       24
       +
         sops.secrets = _utils.genSecrets "balls" ["balls_secret"] {owner = "balls";};

     

       25
       25
       +
         # -> sops.secrets."balls/balls_secret" = {owner = "balls";};

     

       26
       26
       +
       }

     

       27
       27
       +
       ```

     

       28
       28
       +
       

     

       29
       29
       +
       See <https://github.com/soopyc/nix-on-koumakan/blob/b7983776143c15c91df69ef34ba4264a22047ec6/systems/koumakan/services/fedivese/akkoma.nix#L8-L34> for a more extensive example

+23

docs/src/utils/mkNginxFile.md

···

       1
       1
       +
       # `_utils.mkNginxFile`

     

       2
       2
       +
       `{filename<str> ? "index.html", content<str>, status<int> ? 200} -> {alias<str>, tryFiles<str>}`

     

       3
       3
       +
       

     

       4
       4
       +
       Helper function to generate an attrset compatible with a nginx vhost `locations` attribute that serves a single file.

     

       5
       5
       +
       

     

       6
       6
       +
       ## Example

     

       7
       7
       +
       

     

       8
       8
       +
       ### Without filename

     

       9
       9
       +
       ```nix

     

       10
       10
       +
       services.nginx.virtualHosts."example.com".locations."/" = _utils.mkNginxFile {

     

       11
       11
       +
         content = ''

     

       12
       12
       +
           <!doctype html><html><body>We've been trying to reach you about your car's Extended Warranty.</body></html>

     

       13
       13
       +
         '';

     

       14
       14
       +
       };

     

       15
       15
       +
       ```

     

       16
       16
       +
       

     

       17
       17
       +
       ### With filename

     

       18
       18
       +
       ```nix

     

       19
       19
       +
       services.nginx.virtualHosts."filename.example.com".locations."/filename" = _utils.mkNginxFile {

     

       20
       20
       +
         content = "the filename doesn't really matter, but it's there to help you figure out where your things are";

     

       21
       21
       +
         filename = "random.txt";

     

       22
       22
       +
       }

     

       23
       23
       +
       ```

+19

docs/src/utils/mkNginxJSON.md

···

       1
       1
       +
       # `_utils.mkNginxJSON`

     

       2
       2
       +
       `filename<str> -> freeformAttrset ==> attrset`

     

       3
       3
       +
       

     

       4
       4
       +
       Simple wrapper around [`mkNginxFile`](./mkNginxFile.md) that takes in an attrset and formats it as JSON.

     

       5
       5
       +
       

     

       6
       6
       +
       Note that the function signature is different in that it doesn't take in only one attrset.

     

       7
       7
       +
       This may change in the future.

     

       8
       8
       +
       

     

       9
       9
       +
       ## Example

     

       10
       10
       +
       ```nix

     

       11
       11
       +
       services.nginx.virtualHosts."balls.org" = _utils.mkVhost {

     

       12
       12
       +
         locations."/" = _utils.mkNginxJSON "index.json" {

     

       13
       13
       +
           arbitraryAttribute = "arbitraryValue";

     

       14
       14
       +
           doTheyKnow = false;

     

       15
       15
       +
         };

     

       16
       16
       +
       };

     

       17
       17
       +
       ```

     

       18
       18
       +
       

     

       19
       19
       +
       <!-- TODO: check if Content-Type is correctly returned with this -->

+21

docs/src/utils/mkSimpleProxy.md

···

       1
       1
       +
       # `_utils.mkSimpleProxy`

     

       2
       2
       +
       `{port, protocol, location, websockets, extraConfig} -> freeformAttrset`

     

       3
       3
       +
       

     

       4
       4
       +
       make a simple reverse proxy

     

       5
       5
       +
       

     

       6
       6
       +
       takes a set:

     

       7
       7
       +
       ```nix

     

       8
       8
       +
       {

     

       9
       9
       +
         port,

     

       10
       10
       +
         protocol ? "http",

     

       11
       11
       +
         location ? "/",

     

       12
       12
       +
         websockets ? false,

     

       13
       13
       +
         extraConfig ? {}

     

       14
       14
       +
       }

     

       15
       15
       +
       ```

     

       16
       16
       +
       

     

       17
       17
       +
       It is recommended to override/add attributes with `extraConfig` to

     

       18
       18
       +
       preserve defaults.

     

       19
       19
       +
       

     

       20
       20
       +
       Items in `extraConfig` are merged verbatim to the base attrset with defaults.

     

       21
       21
       +
       They are overridden based on their priority order (i.e. via `lib.mk{Default,Force,Order}`).

+11

docs/src/utils/mkVhost.md

···

       1
       1
       +
       # `_utils.mkVhost`

     

       2
       2
       +
       `freeformAttrset -> freeformAttrset`

     

       3
       3
       +
       

     

       4
       4
       +
       make a virtual host with sensible defaults.

     

       5
       5
       +
       

     

       6
       6
       +
       pass in an attrset to override the defaults. the attrset is essentially the same as any virtual host config.

     

       7
       7
       +
       

     

       8
       8
       +
       ## Example

     

       9
       9
       +
       ```nix

     

       10
       10
       +
       services.nginx.virtualHosts."balls.example" = _utils.mkVhost {};

     

       11
       11
       +
       ```

+49

docs/src/utils/setupSecrets.md

···

       1
       1
       +
       # `_utils.setupSecrets`

     

       2
       2
       +
       `attrset<nixos config attr> -> {namespace<str> ? "", secrets[list<str>], config ? freeformAttrset} -> secretHelpers`

     

       3
       3
       +
       

     

       4
       4
       +
       This is a higher-level setup that wraps around `_utils.genSecrets` and provides some additional helper functions.

     

       5
       5
       +
       Usage of this function should make more sense than just using `genSecrets`.

     

       6
       6
       +
       

     

       7
       7
       +
       ```admonish note

     

       8
       8
       +
       `<ReturnValue>.generate` is not actually a function. The attrset is "already" "rendered" should it be actually

     

       9
       9
       +
       resolved by not being ignored by lazy eval. This is essentially equivalent to `genSecrets`, but is now an inline module

     

       10
       10
       +
       that can be put inside an input block instead of being a random attrset.

     

       11
       11
       +
       ```

     

       12
       12
       +
       

     

       13
       13
       +
       NOTE: does not support overriding config for only 1 path. might implement when demand arises.

     

       14
       14
       +
       

     

       15
       15
       +
       The definition of `secretHelpers` is defined as follows:

     

       16
       16
       +
       ```nix

     

       17
       17
       +
       secretHelpers = {

     

       18
       18
       +
         generate    = {}; # => {sops.secrets.* = <sopsConfig>} (inline module)

     

       19
       19
       +
         get         = path: ""; # => actual path of the secret, usually /run/secrets/the/secret

     

       20
       20
       +
       

     

       21
       21
       +
         placeholder = path: ""; # => placeholder string generated by sops-nix, for that secret path to be used in templates.

     

       22
       22
       +
         getTemplate = file: ""; # => actual path of the template, realized at activation time, similar to the get function.

     

       23
       23
       +
         mkTemplate  = file: content: {}; # => {sops.templates.* = ...;}

     

       24
       24
       +
         #             ^ => filename of the template. can be any arbitrary string.

     

       25
       25
       +
       }

     

       26
       26
       +
       ```

     

       27
       27
       +
       

     

       28
       28
       +
       ## Example

     

       29
       29
       +
       ```nix

     

       30
       30
       +
       { _utils, config, ... }: let

     

       31
       31
       +
         secrets = _utils.setupSecrets config {

     

       32
       32
       +
           namespace = "balls";  # for us, the namespace is just the top level element in our secrets yaml file.

     

       33
       33
       +
           config = {

     

       34
       34
       +
             owner = "jane";

     

       35
       35
       +
           };

     

       36
       36
       +
           secrets = [ "my/definitions/gock" "my/sizes/gock" ];

     

       37
       37
       +
         };

     

       38
       38
       +
       in {

     

       39
       39
       +
         imports = [

     

       40
       40
       +
           secrets.generate

     

       41
       41
       +
           (secrets.mkTemplate "my-secret.env" ''

     

       42
       42
       +
             MY_GOCK_SIZE=${secrets.placeholder "my/sizes/gock"}

     

       43
       43
       +
           '')

     

       44
       44
       +
         ];

     

       45
       45
       +
       

     

       46
       46
       +
         some.service.settings.gock.file = secrets.get "my/definitions/gock";  # resolves to the path of balls/my/definitions/gock.

     

       47
       47
       +
         some.service.settings.envFile = secrets.getTemplate "my-secret.env";

     

       48
       48
       +
       }

     

       49
       49
       +
       ```

+493

docs/theme/highlight.js

···

       1
       1
       +
       /*!

     

       2
       2
       +
         Highlight.js v11.9.0 (git: ca77d5b733)

     

       3
       3
       +
         (c) 2006-2024 undefined and other contributors

     

       4
       4
       +
         License: BSD-3-Clause

     

       5
       5
       +
        */

     

       6
       6
       +
       var hljs=function(){"use strict";function e(n){

     

       7
       7
       +
       return n instanceof Map?n.clear=n.delete=n.set=()=>{

     

       8
       8
       +
       throw Error("map is read-only")}:n instanceof Set&&(n.add=n.clear=n.delete=()=>{

     

       9
       9
       +
       throw Error("set is read-only")

     

       10
       10
       +
       }),Object.freeze(n),Object.getOwnPropertyNames(n).forEach((t=>{

     

       11
       11
       +
       const a=n[t],s=typeof a;"object"!==s&&"function"!==s||Object.isFrozen(a)||e(a)

     

       12
       12
       +
       })),n}class n{constructor(e){

     

       13
       13
       +
       void 0===e.data&&(e.data={}),this.data=e.data,this.isMatchIgnored=!1}

     

       14
       14
       +
       ignoreMatch(){this.isMatchIgnored=!0}}function t(e){

     

       15
       15
       +
       return e.replace(/&/g,"&amp;").replace(/</g,"&lt;").replace(/>/g,"&gt;").replace(/"/g,"&quot;").replace(/'/g,"&#x27;")

     

       16
       16
       +
       }function a(e,...n){const t=Object.create(null);for(const n in e)t[n]=e[n]

     

       17
       17
       +
       ;return n.forEach((e=>{for(const n in e)t[n]=e[n]})),t}const s=e=>!!e.scope

     

       18
       18
       +
       ;class i{constructor(e,n){

     

       19
       19
       +
       this.buffer="",this.classPrefix=n.classPrefix,e.walk(this)}addText(e){

     

       20
       20
       +
       this.buffer+=t(e)}openNode(e){if(!s(e))return;const n=((e,{prefix:n})=>{

     

       21
       21
       +
       if(e.startsWith("language:"))return e.replace("language:","language-")

     

       22
       22
       +
       ;if(e.includes(".")){const t=e.split(".")

     

       23
       23
       +
       ;return[`${n}${t.shift()}`,...t.map(((e,n)=>`${e}${"_".repeat(n+1)}`))].join(" ")

     

       24
       24
       +
       }return`${n}${e}`})(e.scope,{prefix:this.classPrefix});this.span(n)}

     

       25
       25
       +
       closeNode(e){s(e)&&(this.buffer+="</span>")}value(){return this.buffer}span(e){

     

       26
       26
       +
       this.buffer+=`<span class="${e}">`}}const r=(e={})=>{const n={children:[]}

     

       27
       27
       +
       ;return Object.assign(n,e),n};class o{constructor(){

     

       28
       28
       +
       this.rootNode=r(),this.stack=[this.rootNode]}get top(){

     

       29
       29
       +
       return this.stack[this.stack.length-1]}get root(){return this.rootNode}add(e){

     

       30
       30
       +
       this.top.children.push(e)}openNode(e){const n=r({scope:e})

     

       31
       31
       +
       ;this.add(n),this.stack.push(n)}closeNode(){

     

       32
       32
       +
       if(this.stack.length>1)return this.stack.pop()}closeAllNodes(){

     

       33
       33
       +
       for(;this.closeNode(););}toJSON(){return JSON.stringify(this.rootNode,null,4)}

     

       34
       34
       +
       walk(e){return this.constructor._walk(e,this.rootNode)}static _walk(e,n){

     

       35
       35
       +
       return"string"==typeof n?e.addText(n):n.children&&(e.openNode(n),

     

       36
       36
       +
       n.children.forEach((n=>this._walk(e,n))),e.closeNode(n)),e}static _collapse(e){

     

       37
       37
       +
       "string"!=typeof e&&e.children&&(e.children.every((e=>"string"==typeof e))?e.children=[e.children.join("")]:e.children.forEach((e=>{

     

       38
       38
       +
       o._collapse(e)})))}}class c extends o{constructor(e){super(),this.options=e}

     

       39
       39
       +
       addText(e){""!==e&&this.add(e)}startScope(e){this.openNode(e)}endScope(){

     

       40
       40
       +
       this.closeNode()}__addSublanguage(e,n){const t=e.root

     

       41
       41
       +
       ;n&&(t.scope="language:"+n),this.add(t)}toHTML(){

     

       42
       42
       +
       return new i(this,this.options).value()}finalize(){

     

       43
       43
       +
       return this.closeAllNodes(),!0}}function l(e){

     

       44
       44
       +
       return e?"string"==typeof e?e:e.source:null}function g(e){return b("(?=",e,")")}

     

       45
       45
       +
       function d(e){return b("(?:",e,")*")}function u(e){return b("(?:",e,")?")}

     

       46
       46
       +
       function b(...e){return e.map((e=>l(e))).join("")}function h(...e){const n=(e=>{

     

       47
       47
       +
       const n=e[e.length-1]

     

       48
       48
       +
       ;return"object"==typeof n&&n.constructor===Object?(e.splice(e.length-1,1),n):{}

     

       49
       49
       +
       })(e);return"("+(n.capture?"":"?:")+e.map((e=>l(e))).join("|")+")"}

     

       50
       50
       +
       function f(e){return RegExp(e.toString()+"|").exec("").length-1}

     

       51
       51
       +
       const p=/\[(?:[^\\\]]|\\.)*\]|\(\??|\\([1-9][0-9]*)|\\./

     

       52
       52
       +
       ;function m(e,{joinWith:n}){let t=0;return e.map((e=>{t+=1;const n=t

     

       53
       53
       +
       ;let a=l(e),s="";for(;a.length>0;){const e=p.exec(a);if(!e){s+=a;break}

     

       54
       54
       +
       s+=a.substring(0,e.index),

     

       55
       55
       +
       a=a.substring(e.index+e[0].length),"\\"===e[0][0]&&e[1]?s+="\\"+(Number(e[1])+n):(s+=e[0],

     

       56
       56
       +
       "("===e[0]&&t++)}return s})).map((e=>`(${e})`)).join(n)}

     

       57
       57
       +
       const _="[a-zA-Z]\\w*",E="[a-zA-Z_]\\w*",y="\\b\\d+(\\.\\d+)?",w="(-?)(\\b0[xX][a-fA-F0-9]+|(\\b\\d+(\\.\\d*)?|\\.\\d+)([eE][-+]?\\d+)?)",N="\\b(0b[01]+)",S={

     

       58
       58
       +
       begin:"\\\\[\\s\\S]",relevance:0},v={scope:"string",begin:"'",end:"'",

     

       59
       59
       +
       illegal:"\\n",contains:[S]},x={scope:"string",begin:'"',end:'"',illegal:"\\n",

     

       60
       60
       +
       contains:[S]},A=(e,n,t={})=>{const s=a({scope:"comment",begin:e,end:n,

     

       61
       61
       +
       contains:[]},t);s.contains.push({scope:"doctag",

     

       62
       62
       +
       begin:"[ ]*(?=(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):)",

     

       63
       63
       +
       end:/(TODO|FIXME|NOTE|BUG|OPTIMIZE|HACK|XXX):/,excludeBegin:!0,relevance:0})

     

       64
       64
       +
       ;const i=h("I","a","is","so","us","to","at","if","in","it","on",/[A-Za-z]+['](d|ve|re|ll|t|s|n)/,/[A-Za-z]+[-][a-z]+/,/[A-Za-z][a-z]{2,}/)

     

       65
       65
       +
       ;return s.contains.push({begin:b(/[ ]+/,"(",i,/[.]?[:]?([.][ ]|[ ])/,"){3}")}),s

     

       66
       66
       +
       },O=A("//","$"),k=A("/\\*","\\*/"),R=A("#","$");var M=Object.freeze({

     

       67
       67
       +
       __proto__:null,APOS_STRING_MODE:v,BACKSLASH_ESCAPE:S,BINARY_NUMBER_MODE:{

     

       68
       68
       +
       scope:"number",begin:N,relevance:0},BINARY_NUMBER_RE:N,COMMENT:A,

     

       69
       69
       +
       C_BLOCK_COMMENT_MODE:k,C_LINE_COMMENT_MODE:O,C_NUMBER_MODE:{scope:"number",

     

       70
       70
       +
       begin:w,relevance:0},C_NUMBER_RE:w,END_SAME_AS_BEGIN:e=>Object.assign(e,{

     

       71
       71
       +
       "on:begin":(e,n)=>{n.data._beginMatch=e[1]},"on:end":(e,n)=>{

     

       72
       72
       +
       n.data._beginMatch!==e[1]&&n.ignoreMatch()}}),HASH_COMMENT_MODE:R,IDENT_RE:_,

     

       73
       73
       +
       MATCH_NOTHING_RE:/\b\B/,METHOD_GUARD:{begin:"\\.\\s*"+E,relevance:0},

     

       74
       74
       +
       NUMBER_MODE:{scope:"number",begin:y,relevance:0},NUMBER_RE:y,

     

       75
       75
       +
       PHRASAL_WORDS_MODE:{

     

       76
       76
       +
       begin:/\b(a|an|the|are|I'm|isn't|don't|doesn't|won't|but|just|should|pretty|simply|enough|gonna|going|wtf|so|such|will|you|your|they|like|more)\b/

     

       77
       77
       +
       },QUOTE_STRING_MODE:x,REGEXP_MODE:{scope:"regexp",begin:/\/(?=[^/\n]*\/)/,

     

       78
       78
       +
       end:/\/[gimuy]*/,contains:[S,{begin:/\[/,end:/\]/,relevance:0,contains:[S]}]},

     

       79
       79
       +
       RE_STARTERS_RE:"!|!=|!==|%|%=|&|&&|&=|\\*|\\*=|\\+|\\+=|,|-|-=|/=|/|:|;|<<|<<=|<=|<|===|==|=|>>>=|>>=|>=|>>>|>>|>|\\?|\\[|\\{|\\(|\\^|\\^=|\\||\\|=|\\|\\||~",

     

       80
       80
       +
       SHEBANG:(e={})=>{const n=/^#![ ]*\//

     

       81
       81
       +
       ;return e.binary&&(e.begin=b(n,/.*\b/,e.binary,/\b.*/)),a({scope:"meta",begin:n,

     

       82
       82
       +
       end:/$/,relevance:0,"on:begin":(e,n)=>{0!==e.index&&n.ignoreMatch()}},e)},

     

       83
       83
       +
       TITLE_MODE:{scope:"title",begin:_,relevance:0},UNDERSCORE_IDENT_RE:E,

     

       84
       84
       +
       UNDERSCORE_TITLE_MODE:{scope:"title",begin:E,relevance:0}});function T(e,n){

     

       85
       85
       +
       "."===e.input[e.index-1]&&n.ignoreMatch()}function I(e,n){

     

       86
       86
       +
       void 0!==e.className&&(e.scope=e.className,delete e.className)}function B(e,n){

     

       87
       87
       +
       n&&e.beginKeywords&&(e.begin="\\b("+e.beginKeywords.split(" ").join("|")+")(?!\\.)(?=\\b|\\s)",

     

       88
       88
       +
       e.__beforeBegin=T,e.keywords=e.keywords||e.beginKeywords,delete e.beginKeywords,

     

       89
       89
       +
       void 0===e.relevance&&(e.relevance=0))}function C(e,n){

     

       90
       90
       +
       Array.isArray(e.illegal)&&(e.illegal=h(...e.illegal))}function L(e,n){

     

       91
       91
       +
       if(e.match){

     

       92
       92
       +
       if(e.begin||e.end)throw Error("begin & end are not supported with match")

     

       93
       93
       +
       ;e.begin=e.match,delete e.match}}function $(e,n){

     

       94
       94
       +
       void 0===e.relevance&&(e.relevance=1)}const j=(e,n)=>{if(!e.beforeMatch)return

     

       95
       95
       +
       ;if(e.starts)throw Error("beforeMatch cannot be used with starts")

     

       96
       96
       +
       ;const t=Object.assign({},e);Object.keys(e).forEach((n=>{delete e[n]

     

       97
       97
       +
       })),e.keywords=t.keywords,e.begin=b(t.beforeMatch,g(t.begin)),e.starts={

     

       98
       98
       +
       relevance:0,contains:[Object.assign(t,{endsParent:!0})]

     

       99
       99
       +
       },e.relevance=0,delete t.beforeMatch

     

       100
       100
       +
       },D=["of","and","for","in","not","or","if","then","parent","list","value"],P="keyword"

     

       101
       101
       +
       ;function H(e,n,t=P){const a=Object.create(null)

     

       102
       102
       +
       ;return"string"==typeof e?s(t,e.split(" ")):Array.isArray(e)?s(t,e):Object.keys(e).forEach((t=>{

     

       103
       103
       +
       Object.assign(a,H(e[t],n,t))})),a;function s(e,t){

     

       104
       104
       +
       n&&(t=t.map((e=>e.toLowerCase()))),t.forEach((n=>{const t=n.split("|")

     

       105
       105
       +
       ;a[t[0]]=[e,U(t[0],t[1])]}))}}function U(e,n){

     

       106
       106
       +
       return n?Number(n):(e=>D.includes(e.toLowerCase()))(e)?0:1}const z={},F=e=>{

     

       107
       107
       +
       console.error(e)},Z=(e,...n)=>{console.log("WARN: "+e,...n)},K=(e,n)=>{

     

       108
       108
       +
       z[`${e}/${n}`]||(console.log(`Deprecated as of ${e}. ${n}`),z[`${e}/${n}`]=!0)

     

       109
       109
       +
       },G=Error();function W(e,n,{key:t}){let a=0;const s=e[t],i={},r={}

     

       110
       110
       +
       ;for(let e=1;e<=n.length;e++)r[e+a]=s[e],i[e+a]=!0,a+=f(n[e-1])

     

       111
       111
       +
       ;e[t]=r,e[t]._emit=i,e[t]._multi=!0}function X(e){(e=>{

     

       112
       112
       +
       e.scope&&"object"==typeof e.scope&&null!==e.scope&&(e.beginScope=e.scope,

     

       113
       113
       +
       delete e.scope)})(e),"string"==typeof e.beginScope&&(e.beginScope={

     

       114
       114
       +
       _wrap:e.beginScope}),"string"==typeof e.endScope&&(e.endScope={_wrap:e.endScope

     

       115
       115
       +
       }),(e=>{if(Array.isArray(e.begin)){

     

       116
       116
       +
       if(e.skip||e.excludeBegin||e.returnBegin)throw F("skip, excludeBegin, returnBegin not compatible with beginScope: {}"),

     

       117
       117
       +
       G

     

       118
       118
       +
       ;if("object"!=typeof e.beginScope||null===e.beginScope)throw F("beginScope must be object"),

     

       119
       119
       +
       G;W(e,e.begin,{key:"beginScope"}),e.begin=m(e.begin,{joinWith:""})}})(e),(e=>{

     

       120
       120
       +
       if(Array.isArray(e.end)){

     

       121
       121
       +
       if(e.skip||e.excludeEnd||e.returnEnd)throw F("skip, excludeEnd, returnEnd not compatible with endScope: {}"),

     

       122
       122
       +
       G

     

       123
       123
       +
       ;if("object"!=typeof e.endScope||null===e.endScope)throw F("endScope must be object"),

     

       124
       124
       +
       G;W(e,e.end,{key:"endScope"}),e.end=m(e.end,{joinWith:""})}})(e)}function q(e){

     

       125
       125
       +
       function n(n,t){

     

       126
       126
       +
       return RegExp(l(n),"m"+(e.case_insensitive?"i":"")+(e.unicodeRegex?"u":"")+(t?"g":""))

     

       127
       127
       +
       }class t{constructor(){

     

       128
       128
       +
       this.matchIndexes={},this.regexes=[],this.matchAt=1,this.position=0}

     

       129
       129
       +
       addRule(e,n){

     

       130
       130
       +
       n.position=this.position++,this.matchIndexes[this.matchAt]=n,this.regexes.push([n,e]),

     

       131
       131
       +
       this.matchAt+=f(e)+1}compile(){0===this.regexes.length&&(this.exec=()=>null)

     

       132
       132
       +
       ;const e=this.regexes.map((e=>e[1]));this.matcherRe=n(m(e,{joinWith:"|"

     

       133
       133
       +
       }),!0),this.lastIndex=0}exec(e){this.matcherRe.lastIndex=this.lastIndex

     

       134
       134
       +
       ;const n=this.matcherRe.exec(e);if(!n)return null

     

       135
       135
       +
       ;const t=n.findIndex(((e,n)=>n>0&&void 0!==e)),a=this.matchIndexes[t]

     

       136
       136
       +
       ;return n.splice(0,t),Object.assign(n,a)}}class s{constructor(){

     

       137
       137
       +
       this.rules=[],this.multiRegexes=[],

     

       138
       138
       +
       this.count=0,this.lastIndex=0,this.regexIndex=0}getMatcher(e){

     

       139
       139
       +
       if(this.multiRegexes[e])return this.multiRegexes[e];const n=new t

     

       140
       140
       +
       ;return this.rules.slice(e).forEach((([e,t])=>n.addRule(e,t))),

     

       141
       141
       +
       n.compile(),this.multiRegexes[e]=n,n}resumingScanAtSamePosition(){

     

       142
       142
       +
       return 0!==this.regexIndex}considerAll(){this.regexIndex=0}addRule(e,n){

     

       143
       143
       +
       this.rules.push([e,n]),"begin"===n.type&&this.count++}exec(e){

     

       144
       144
       +
       const n=this.getMatcher(this.regexIndex);n.lastIndex=this.lastIndex

     

       145
       145
       +
       ;let t=n.exec(e)

     

       146
       146
       +
       ;if(this.resumingScanAtSamePosition())if(t&&t.index===this.lastIndex);else{

     

       147
       147
       +
       const n=this.getMatcher(0);n.lastIndex=this.lastIndex+1,t=n.exec(e)}

     

       148
       148
       +
       return t&&(this.regexIndex+=t.position+1,

     

       149
       149
       +
       this.regexIndex===this.count&&this.considerAll()),t}}

     

       150
       150
       +
       if(e.compilerExtensions||(e.compilerExtensions=[]),

     

       151
       151
       +
       e.contains&&e.contains.includes("self"))throw Error("ERR: contains `self` is not supported at the top-level of a language.  See documentation.")

     

       152
       152
       +
       ;return e.classNameAliases=a(e.classNameAliases||{}),function t(i,r){const o=i

     

       153
       153
       +
       ;if(i.isCompiled)return o

     

       154
       154
       +
       ;[I,L,X,j].forEach((e=>e(i,r))),e.compilerExtensions.forEach((e=>e(i,r))),

     

       155
       155
       +
       i.__beforeBegin=null,[B,C,$].forEach((e=>e(i,r))),i.isCompiled=!0;let c=null

     

       156
       156
       +
       ;return"object"==typeof i.keywords&&i.keywords.$pattern&&(i.keywords=Object.assign({},i.keywords),

     

       157
       157
       +
       c=i.keywords.$pattern,

     

       158
       158
       +
       delete i.keywords.$pattern),c=c||/\w+/,i.keywords&&(i.keywords=H(i.keywords,e.case_insensitive)),

     

       159
       159
       +
       o.keywordPatternRe=n(c,!0),

     

       160
       160
       +
       r&&(i.begin||(i.begin=/\B|\b/),o.beginRe=n(o.begin),i.end||i.endsWithParent||(i.end=/\B|\b/),

     

       161
       161
       +
       i.end&&(o.endRe=n(o.end)),

     

       162
       162
       +
       o.terminatorEnd=l(o.end)||"",i.endsWithParent&&r.terminatorEnd&&(o.terminatorEnd+=(i.end?"|":"")+r.terminatorEnd)),

     

       163
       163
       +
       i.illegal&&(o.illegalRe=n(i.illegal)),

     

       164
       164
       +
       i.contains||(i.contains=[]),i.contains=[].concat(...i.contains.map((e=>(e=>(e.variants&&!e.cachedVariants&&(e.cachedVariants=e.variants.map((n=>a(e,{

     

       165
       165
       +
       variants:null},n)))),e.cachedVariants?e.cachedVariants:J(e)?a(e,{

     

       166
       166
       +
       starts:e.starts?a(e.starts):null

     

       167
       167
       +
       }):Object.isFrozen(e)?a(e):e))("self"===e?i:e)))),i.contains.forEach((e=>{t(e,o)

     

       168
       168
       +
       })),i.starts&&t(i.starts,r),o.matcher=(e=>{const n=new s

     

       169
       169
       +
       ;return e.contains.forEach((e=>n.addRule(e.begin,{rule:e,type:"begin"

     

       170
       170
       +
       }))),e.terminatorEnd&&n.addRule(e.terminatorEnd,{type:"end"

     

       171
       171
       +
       }),e.illegal&&n.addRule(e.illegal,{type:"illegal"}),n})(o),o}(e)}function J(e){

     

       172
       172
       +
       return!!e&&(e.endsWithParent||J(e.starts))}class V extends Error{

     

       173
       173
       +
       constructor(e,n){super(e),this.name="HTMLInjectionError",this.html=n}}

     

       174
       174
       +
       const Q=t,Y=a,ee=Symbol("nomatch"),ne=t=>{

     

       175
       175
       +
       const a=Object.create(null),s=Object.create(null),i=[];let r=!0

     

       176
       176
       +
       ;const o="Could not find the language '{}', did you forget to load/include a language module?",l={

     

       177
       177
       +
       disableAutodetect:!0,name:"Plain text",contains:[]};let f={

     

       178
       178
       +
       ignoreUnescapedHTML:!1,throwUnescapedHTML:!1,noHighlightRe:/^(no-?highlight)$/i,

     

       179
       179
       +
       languageDetectRe:/\blang(?:uage)?-([\w-]+)\b/i,classPrefix:"hljs-",

     

       180
       180
       +
       cssSelector:"pre code",languages:null,__emitter:c};function p(e){

     

       181
       181
       +
       return f.noHighlightRe.test(e)}function m(e,n,t){let a="",s=""

     

       182
       182
       +
       ;"object"==typeof n?(a=e,

     

       183
       183
       +
       t=n.ignoreIllegals,s=n.language):(K("10.7.0","highlight(lang, code, ...args) has been deprecated."),

     

       184
       184
       +
       K("10.7.0","Please use highlight(code, options) instead.\nhttps://github.com/highlightjs/highlight.js/issues/2277"),

     

       185
       185
       +
       s=e,a=n),void 0===t&&(t=!0);const i={code:a,language:s};A("before:highlight",i)

     

       186
       186
       +
       ;const r=i.result?i.result:_(i.language,i.code,t)

     

       187
       187
       +
       ;return r.code=i.code,A("after:highlight",r),r}function _(e,t,s,i){

     

       188
       188
       +
       const c=Object.create(null);function l(){if(!A.keywords)return void k.addText(R)

     

       189
       189
       +
       ;let e=0;A.keywordPatternRe.lastIndex=0;let n=A.keywordPatternRe.exec(R),t=""

     

       190
       190
       +
       ;for(;n;){t+=R.substring(e,n.index)

     

       191
       191
       +
       ;const s=N.case_insensitive?n[0].toLowerCase():n[0],i=(a=s,A.keywords[a]);if(i){

     

       192
       192
       +
       const[e,a]=i

     

       193
       193
       +
       ;if(k.addText(t),t="",c[s]=(c[s]||0)+1,c[s]<=7&&(M+=a),e.startsWith("_"))t+=n[0];else{

     

       194
       194
       +
       const t=N.classNameAliases[e]||e;d(n[0],t)}}else t+=n[0]

     

       195
       195
       +
       ;e=A.keywordPatternRe.lastIndex,n=A.keywordPatternRe.exec(R)}var a

     

       196
       196
       +
       ;t+=R.substring(e),k.addText(t)}function g(){null!=A.subLanguage?(()=>{

     

       197
       197
       +
       if(""===R)return;let e=null;if("string"==typeof A.subLanguage){

     

       198
       198
       +
       if(!a[A.subLanguage])return void k.addText(R)

     

       199
       199
       +
       ;e=_(A.subLanguage,R,!0,O[A.subLanguage]),O[A.subLanguage]=e._top

     

       200
       200
       +
       }else e=E(R,A.subLanguage.length?A.subLanguage:null)

     

       201
       201
       +
       ;A.relevance>0&&(M+=e.relevance),k.__addSublanguage(e._emitter,e.language)

     

       202
       202
       +
       })():l(),R=""}function d(e,n){

     

       203
       203
       +
       ""!==e&&(k.startScope(n),k.addText(e),k.endScope())}function u(e,n){let t=1

     

       204
       204
       +
       ;const a=n.length-1;for(;t<=a;){if(!e._emit[t]){t++;continue}

     

       205
       205
       +
       const a=N.classNameAliases[e[t]]||e[t],s=n[t];a?d(s,a):(R=s,l(),R=""),t++}}

     

       206
       206
       +
       function b(e,n){

     

       207
       207
       +
       return e.scope&&"string"==typeof e.scope&&k.openNode(N.classNameAliases[e.scope]||e.scope),

     

       208
       208
       +
       e.beginScope&&(e.beginScope._wrap?(d(R,N.classNameAliases[e.beginScope._wrap]||e.beginScope._wrap),

     

       209
       209
       +
       R=""):e.beginScope._multi&&(u(e.beginScope,n),R="")),A=Object.create(e,{parent:{

     

       210
       210
       +
       value:A}}),A}function h(e,t,a){let s=((e,n)=>{const t=e&&e.exec(n)

     

       211
       211
       +
       ;return t&&0===t.index})(e.endRe,a);if(s){if(e["on:end"]){const a=new n(e)

     

       212
       212
       +
       ;e["on:end"](t,a),a.isMatchIgnored&&(s=!1)}if(s){

     

       213
       213
       +
       for(;e.endsParent&&e.parent;)e=e.parent;return e}}

     

       214
       214
       +
       if(e.endsWithParent)return h(e.parent,t,a)}function p(e){

     

       215
       215
       +
       return 0===A.matcher.regexIndex?(R+=e[0],1):(B=!0,0)}function m(e){

     

       216
       216
       +
       const n=e[0],a=t.substring(e.index),s=h(A,e,a);if(!s)return ee;const i=A

     

       217
       217
       +
       ;A.endScope&&A.endScope._wrap?(g(),

     

       218
       218
       +
       d(n,A.endScope._wrap)):A.endScope&&A.endScope._multi?(g(),

     

       219
       219
       +
       u(A.endScope,e)):i.skip?R+=n:(i.returnEnd||i.excludeEnd||(R+=n),

     

       220
       220
       +
       g(),i.excludeEnd&&(R=n));do{

     

       221
       221
       +
       A.scope&&k.closeNode(),A.skip||A.subLanguage||(M+=A.relevance),A=A.parent

     

       222
       222
       +
       }while(A!==s.parent);return s.starts&&b(s.starts,e),i.returnEnd?0:n.length}

     

       223
       223
       +
       let y={};function w(a,i){const o=i&&i[0];if(R+=a,null==o)return g(),0

     

       224
       224
       +
       ;if("begin"===y.type&&"end"===i.type&&y.index===i.index&&""===o){

     

       225
       225
       +
       if(R+=t.slice(i.index,i.index+1),!r){const n=Error(`0 width match regex (${e})`)

     

       226
       226
       +
       ;throw n.languageName=e,n.badRule=y.rule,n}return 1}

     

       227
       227
       +
       if(y=i,"begin"===i.type)return(e=>{

     

       228
       228
       +
       const t=e[0],a=e.rule,s=new n(a),i=[a.__beforeBegin,a["on:begin"]]

     

       229
       229
       +
       ;for(const n of i)if(n&&(n(e,s),s.isMatchIgnored))return p(t)

     

       230
       230
       +
       ;return a.skip?R+=t:(a.excludeBegin&&(R+=t),

     

       231
       231
       +
       g(),a.returnBegin||a.excludeBegin||(R=t)),b(a,e),a.returnBegin?0:t.length})(i)

     

       232
       232
       +
       ;if("illegal"===i.type&&!s){

     

       233
       233
       +
       const e=Error('Illegal lexeme "'+o+'" for mode "'+(A.scope||"<unnamed>")+'"')

     

       234
       234
       +
       ;throw e.mode=A,e}if("end"===i.type){const e=m(i);if(e!==ee)return e}

     

       235
       235
       +
       if("illegal"===i.type&&""===o)return 1

     

       236
       236
       +
       ;if(I>1e5&&I>3*i.index)throw Error("potential infinite loop, way more iterations than matches")

     

       237
       237
       +
       ;return R+=o,o.length}const N=S(e)

     

       238
       238
       +
       ;if(!N)throw F(o.replace("{}",e)),Error('Unknown language: "'+e+'"')

     

       239
       239
       +
       ;const v=q(N);let x="",A=i||v;const O={},k=new f.__emitter(f);(()=>{const e=[]

     

       240
       240
       +
       ;for(let n=A;n!==N;n=n.parent)n.scope&&e.unshift(n.scope)

     

       241
       241
       +
       ;e.forEach((e=>k.openNode(e)))})();let R="",M=0,T=0,I=0,B=!1;try{

     

       242
       242
       +
       if(N.__emitTokens)N.__emitTokens(t,k);else{for(A.matcher.considerAll();;){

     

       243
       243
       +
       I++,B?B=!1:A.matcher.considerAll(),A.matcher.lastIndex=T

     

       244
       244
       +
       ;const e=A.matcher.exec(t);if(!e)break;const n=w(t.substring(T,e.index),e)

     

       245
       245
       +
       ;T=e.index+n}w(t.substring(T))}return k.finalize(),x=k.toHTML(),{language:e,

     

       246
       246
       +
       value:x,relevance:M,illegal:!1,_emitter:k,_top:A}}catch(n){

     

       247
       247
       +
       if(n.message&&n.message.includes("Illegal"))return{language:e,value:Q(t),

     

       248
       248
       +
       illegal:!0,relevance:0,_illegalBy:{message:n.message,index:T,

     

       249
       249
       +
       context:t.slice(T-100,T+100),mode:n.mode,resultSoFar:x},_emitter:k};if(r)return{

     

       250
       250
       +
       language:e,value:Q(t),illegal:!1,relevance:0,errorRaised:n,_emitter:k,_top:A}

     

       251
       251
       +
       ;throw n}}function E(e,n){n=n||f.languages||Object.keys(a);const t=(e=>{

     

       252
       252
       +
       const n={value:Q(e),illegal:!1,relevance:0,_top:l,_emitter:new f.__emitter(f)}

     

       253
       253
       +
       ;return n._emitter.addText(e),n})(e),s=n.filter(S).filter(x).map((n=>_(n,e,!1)))

     

       254
       254
       +
       ;s.unshift(t);const i=s.sort(((e,n)=>{

     

       255
       255
       +
       if(e.relevance!==n.relevance)return n.relevance-e.relevance

     

       256
       256
       +
       ;if(e.language&&n.language){if(S(e.language).supersetOf===n.language)return 1

     

       257
       257
       +
       ;if(S(n.language).supersetOf===e.language)return-1}return 0})),[r,o]=i,c=r

     

       258
       258
       +
       ;return c.secondBest=o,c}function y(e){let n=null;const t=(e=>{

     

       259
       259
       +
       let n=e.className+" ";n+=e.parentNode?e.parentNode.className:""

     

       260
       260
       +
       ;const t=f.languageDetectRe.exec(n);if(t){const n=S(t[1])

     

       261
       261
       +
       ;return n||(Z(o.replace("{}",t[1])),

     

       262
       262
       +
       Z("Falling back to no-highlight mode for this block.",e)),n?t[1]:"no-highlight"}

     

       263
       263
       +
       return n.split(/\s+/).find((e=>p(e)||S(e)))})(e);if(p(t))return

     

       264
       264
       +
       ;if(A("before:highlightElement",{el:e,language:t

     

       265
       265
       +
       }),e.dataset.highlighted)return void console.log("Element previously highlighted. To highlight again, first unset `dataset.highlighted`.",e)

     

       266
       266
       +
       ;if(e.children.length>0&&(f.ignoreUnescapedHTML||(console.warn("One of your code blocks includes unescaped HTML. This is a potentially serious security risk."),

     

       267
       267
       +
       console.warn("https://github.com/highlightjs/highlight.js/wiki/security"),

     

       268
       268
       +
       console.warn("The element with unescaped HTML:"),

     

       269
       269
       +
       console.warn(e)),f.throwUnescapedHTML))throw new V("One of your code blocks includes unescaped HTML.",e.innerHTML)

     

       270
       270
       +
       ;n=e;const a=n.textContent,i=t?m(a,{language:t,ignoreIllegals:!0}):E(a)

     

       271
       271
       +
       ;e.innerHTML=i.value,e.dataset.highlighted="yes",((e,n,t)=>{const a=n&&s[n]||t

     

       272
       272
       +
       ;e.classList.add("hljs"),e.classList.add("language-"+a)

     

       273
       273
       +
       })(e,t,i.language),e.result={language:i.language,re:i.relevance,

     

       274
       274
       +
       relevance:i.relevance},i.secondBest&&(e.secondBest={

     

       275
       275
       +
       language:i.secondBest.language,relevance:i.secondBest.relevance

     

       276
       276
       +
       }),A("after:highlightElement",{el:e,result:i,text:a})}let w=!1;function N(){

     

       277
       277
       +
       "loading"!==document.readyState?document.querySelectorAll(f.cssSelector).forEach(y):w=!0

     

       278
       278
       +
       }function S(e){return e=(e||"").toLowerCase(),a[e]||a[s[e]]}

     

       279
       279
       +
       function v(e,{languageName:n}){"string"==typeof e&&(e=[e]),e.forEach((e=>{

     

       280
       280
       +
       s[e.toLowerCase()]=n}))}function x(e){const n=S(e)

     

       281
       281
       +
       ;return n&&!n.disableAutodetect}function A(e,n){const t=e;i.forEach((e=>{

     

       282
       282
       +
       e[t]&&e[t](n)}))}

     

       283
       283
       +
       "undefined"!=typeof window&&window.addEventListener&&window.addEventListener("DOMContentLoaded",(()=>{

     

       284
       284
       +
       w&&N()}),!1),Object.assign(t,{highlight:m,highlightAuto:E,highlightAll:N,

     

       285
       285
       +
       highlightElement:y,

     

       286
       286
       +
       highlightBlock:e=>(K("10.7.0","highlightBlock will be removed entirely in v12.0"),

     

       287
       287
       +
       K("10.7.0","Please use highlightElement now."),y(e)),configure:e=>{f=Y(f,e)},

     

       288
       288
       +
       initHighlighting:()=>{

     

       289
       289
       +
       N(),K("10.6.0","initHighlighting() deprecated.  Use highlightAll() now.")},

     

       290
       290
       +
       initHighlightingOnLoad:()=>{

     

       291
       291
       +
       N(),K("10.6.0","initHighlightingOnLoad() deprecated.  Use highlightAll() now.")

     

       292
       292
       +
       },registerLanguage:(e,n)=>{let s=null;try{s=n(t)}catch(n){

     

       293
       293
       +
       if(F("Language definition for '{}' could not be registered.".replace("{}",e)),

     

       294
       294
       +
       !r)throw n;F(n),s=l}

     

       295
       295
       +
       s.name||(s.name=e),a[e]=s,s.rawDefinition=n.bind(null,t),s.aliases&&v(s.aliases,{

     

       296
       296
       +
       languageName:e})},unregisterLanguage:e=>{delete a[e]

     

       297
       297
       +
       ;for(const n of Object.keys(s))s[n]===e&&delete s[n]},

     

       298
       298
       +
       listLanguages:()=>Object.keys(a),getLanguage:S,registerAliases:v,

     

       299
       299
       +
       autoDetection:x,inherit:Y,addPlugin:e=>{(e=>{

     

       300
       300
       +
       e["before:highlightBlock"]&&!e["before:highlightElement"]&&(e["before:highlightElement"]=n=>{

     

       301
       301
       +
       e["before:highlightBlock"](Object.assign({block:n.el},n))

     

       302
       302
       +
       }),e["after:highlightBlock"]&&!e["after:highlightElement"]&&(e["after:highlightElement"]=n=>{

     

       303
       303
       +
       e["after:highlightBlock"](Object.assign({block:n.el},n))})})(e),i.push(e)},

     

       304
       304
       +
       removePlugin:e=>{const n=i.indexOf(e);-1!==n&&i.splice(n,1)}}),t.debugMode=()=>{

     

       305
       305
       +
       r=!1},t.safeMode=()=>{r=!0},t.versionString="11.9.0",t.regex={concat:b,

     

       306
       306
       +
       lookahead:g,either:h,optional:u,anyNumberOfTimes:d}

     

       307
       307
       +
       ;for(const n in M)"object"==typeof M[n]&&e(M[n]);return Object.assign(t,M),t

     

       308
       308
       +
       },te=ne({});te.newInstance=()=>ne({});var ae=te

     

       309
       309
       +
       ;const se="[A-Za-z$_][0-9A-Za-z$_]*",ie=["as","in","of","if","for","while","finally","var","new","function","do","return","void","else","break","catch","instanceof","with","throw","case","default","try","switch","continue","typeof","delete","let","yield","const","class","debugger","async","await","static","import","from","export","extends"],re=["true","false","null","undefined","NaN","Infinity"],oe=["Object","Function","Boolean","Symbol","Math","Date","Number","BigInt","String","RegExp","Array","Float32Array","Float64Array","Int8Array","Uint8Array","Uint8ClampedArray","Int16Array","Int32Array","Uint16Array","Uint32Array","BigInt64Array","BigUint64Array","Set","Map","WeakSet","WeakMap","ArrayBuffer","SharedArrayBuffer","Atomics","DataView","JSON","Promise","Generator","GeneratorFunction","AsyncFunction","Reflect","Proxy","Intl","WebAssembly"],ce=["Error","EvalError","InternalError","RangeError","ReferenceError","SyntaxError","TypeError","URIError"],le=["setInterval","setTimeout","clearInterval","clearTimeout","require","exports","eval","isFinite","isNaN","parseFloat","parseInt","decodeURI","decodeURIComponent","encodeURI","encodeURIComponent","escape","unescape"],ge=["arguments","this","super","console","window","document","localStorage","sessionStorage","module","global"],de=[].concat(le,oe,ce)

     

       310
       310
       +
       ;var ue=Object.freeze({__proto__:null,grmr_ini:e=>{const n=e.regex,t={

     

       311
       311
       +
       className:"number",relevance:0,variants:[{begin:/([+-]+)?[\d]+_[\d_]+/},{

     

       312
       312
       +
       begin:e.NUMBER_RE}]},a=e.COMMENT();a.variants=[{begin:/;/,end:/$/},{begin:/#/,

     

       313
       313
       +
       end:/$/}];const s={className:"variable",variants:[{begin:/\$[\w\d"][\w\d_]*/},{

     

       314
       314
       +
       begin:/\$\{(.*?)\}/}]},i={className:"literal",

     

       315
       315
       +
       begin:/\bon|off|true|false|yes|no\b/},r={className:"string",

     

       316
       316
       +
       contains:[e.BACKSLASH_ESCAPE],variants:[{begin:"'''",end:"'''",relevance:10},{

     

       317
       317
       +
       begin:'"""',end:'"""',relevance:10},{begin:'"',end:'"'},{begin:"'",end:"'"}]

     

       318
       318
       +
       },o={begin:/\[/,end:/\]/,contains:[a,i,s,r,t,"self"],relevance:0

     

       319
       319
       +
       },c=n.either(/[A-Za-z0-9_-]+/,/"(\\"|[^"])*"/,/'[^']*'/);return{

     

       320
       320
       +
       name:"TOML, also INI",aliases:["toml"],case_insensitive:!0,illegal:/\S/,

     

       321
       321
       +
       contains:[a,{className:"section",begin:/\[+/,end:/\]+/},{

     

       322
       322
       +
       begin:n.concat(c,"(\\s*\\.\\s*",c,")*",n.lookahead(/\s*=\s*[^#\s]/)),

     

       323
       323
       +
       className:"attr",starts:{end:/$/,contains:[a,o,i,s,r,t]}}]}},

     

       324
       324
       +
       grmr_javascript:e=>{const n=e.regex,t=se,a={begin:/<[A-Za-z0-9\\._:-]+/,

     

       325
       325
       +
       end:/\/[A-Za-z0-9\\._:-]+>|\/>/,isTrulyOpeningTag:(e,n)=>{

     

       326
       326
       +
       const t=e[0].length+e.index,a=e.input[t]

     

       327
       327
       +
       ;if("<"===a||","===a)return void n.ignoreMatch();let s

     

       328
       328
       +
       ;">"===a&&(((e,{after:n})=>{const t="</"+e[0].slice(1)

     

       329
       329
       +
       ;return-1!==e.input.indexOf(t,n)})(e,{after:t})||n.ignoreMatch())

     

       330
       330
       +
       ;const i=e.input.substring(t)

     

       331
       331
       +
       ;((s=i.match(/^\s*=/))||(s=i.match(/^\s+extends\s+/))&&0===s.index)&&n.ignoreMatch()

     

       332
       332
       +
       }},s={$pattern:se,keyword:ie,literal:re,built_in:de,"variable.language":ge

     

       333
       333
       +
       },i="[0-9](_?[0-9])*",r=`\\.(${i})`,o="0|[1-9](_?[0-9])*|0[0-7]*[89][0-9]*",c={

     

       334
       334
       +
       className:"number",variants:[{

     

       335
       335
       +
       begin:`(\\b(${o})((${r})|\\.)?|(${r}))[eE][+-]?(${i})\\b`},{

     

       336
       336
       +
       begin:`\\b(${o})\\b((${r})\\b|\\.)?|(${r})\\b`},{

     

       337
       337
       +
       begin:"\\b(0|[1-9](_?[0-9])*)n\\b"},{

     

       338
       338
       +
       begin:"\\b0[xX][0-9a-fA-F](_?[0-9a-fA-F])*n?\\b"},{

     

       339
       339
       +
       begin:"\\b0[bB][0-1](_?[0-1])*n?\\b"},{begin:"\\b0[oO][0-7](_?[0-7])*n?\\b"},{

     

       340
       340
       +
       begin:"\\b0[0-7]+n?\\b"}],relevance:0},l={className:"subst",begin:"\\$\\{",

     

       341
       341
       +
       end:"\\}",keywords:s,contains:[]},g={begin:"html`",end:"",starts:{end:"`",

     

       342
       342
       +
       returnEnd:!1,contains:[e.BACKSLASH_ESCAPE,l],subLanguage:"xml"}},d={

     

       343
       343
       +
       begin:"css`",end:"",starts:{end:"`",returnEnd:!1,

     

       344
       344
       +
       contains:[e.BACKSLASH_ESCAPE,l],subLanguage:"css"}},u={begin:"gql`",end:"",

     

       345
       345
       +
       starts:{end:"`",returnEnd:!1,contains:[e.BACKSLASH_ESCAPE,l],

     

       346
       346
       +
       subLanguage:"graphql"}},b={className:"string",begin:"`",end:"`",

     

       347
       347
       +
       contains:[e.BACKSLASH_ESCAPE,l]},h={className:"comment",

     

       348
       348
       +
       variants:[e.COMMENT(/\/\*\*(?!\/)/,"\\*/",{relevance:0,contains:[{

     

       349
       349
       +
       begin:"(?=@[A-Za-z]+)",relevance:0,contains:[{className:"doctag",

     

       350
       350
       +
       begin:"@[A-Za-z]+"},{className:"type",begin:"\\{",end:"\\}",excludeEnd:!0,

     

       351
       351
       +
       excludeBegin:!0,relevance:0},{className:"variable",begin:t+"(?=\\s*(-)|$)",

     

       352
       352
       +
       endsParent:!0,relevance:0},{begin:/(?=[^\n])\s/,relevance:0}]}]

     

       353
       353
       +
       }),e.C_BLOCK_COMMENT_MODE,e.C_LINE_COMMENT_MODE]

     

       354
       354
       +
       },f=[e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,g,d,u,b,{match:/\$\d+/},c]

     

       355
       355
       +
       ;l.contains=f.concat({begin:/\{/,end:/\}/,keywords:s,contains:["self"].concat(f)

     

       356
       356
       +
       });const p=[].concat(h,l.contains),m=p.concat([{begin:/(\s*)\(/,end:/\)/,

     

       357
       357
       +
       keywords:s,contains:["self"].concat(p)}]),_={className:"params",begin:/(\s*)\(/,

     

       358
       358
       +
       end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:s,contains:m},E={variants:[{

     

       359
       359
       +
       match:[/class/,/\s+/,t,/\s+/,/extends/,/\s+/,n.concat(t,"(",n.concat(/\./,t),")*")],

     

       360
       360
       +
       scope:{1:"keyword",3:"title.class",5:"keyword",7:"title.class.inherited"}},{

     

       361
       361
       +
       match:[/class/,/\s+/,t],scope:{1:"keyword",3:"title.class"}}]},y={relevance:0,

     

       362
       362
       +
       match:n.either(/\bJSON/,/\b[A-Z][a-z]+([A-Z][a-z]*|\d)*/,/\b[A-Z]{2,}([A-Z][a-z]+|\d)+([A-Z][a-z]*)*/,/\b[A-Z]{2,}[a-z]+([A-Z][a-z]+|\d)*([A-Z][a-z]*)*/),

     

       363
       363
       +
       className:"title.class",keywords:{_:[...oe,...ce]}},w={variants:[{

     

       364
       364
       +
       match:[/function/,/\s+/,t,/(?=\s*\()/]},{match:[/function/,/\s*(?=\()/]}],

     

       365
       365
       +
       className:{1:"keyword",3:"title.function"},label:"func.def",contains:[_],

     

       366
       366
       +
       illegal:/%/},N={

     

       367
       367
       +
       match:n.concat(/\b/,(S=[...le,"super","import"].map((e=>e+"\\s*\\(")),

     

       368
       368
       +
       n.concat("(?!",S.join("|"),")")),t,n.lookahead(/\s*\(/)),

     

       369
       369
       +
       className:"title.function",relevance:0};var S;const v={

     

       370
       370
       +
       begin:n.concat(/\./,n.lookahead(n.concat(t,/(?![0-9A-Za-z$_(])/))),end:t,

     

       371
       371
       +
       excludeBegin:!0,keywords:"prototype",className:"property",relevance:0},x={

     

       372
       372
       +
       match:[/get|set/,/\s+/,t,/(?=\()/],className:{1:"keyword",3:"title.function"},

     

       373
       373
       +
       contains:[{begin:/\(\)/},_]

     

       374
       374
       +
       },A="(\\([^()]*(\\([^()]*(\\([^()]*\\)[^()]*)*\\)[^()]*)*\\)|"+e.UNDERSCORE_IDENT_RE+")\\s*=>",O={

     

       375
       375
       +
       match:[/const|var|let/,/\s+/,t,/\s*/,/=\s*/,/(async\s*)?/,n.lookahead(A)],

     

       376
       376
       +
       keywords:"async",className:{1:"keyword",3:"title.function"},contains:[_]}

     

       377
       377
       +
       ;return{name:"JavaScript",aliases:["js","jsx","mjs","cjs"],keywords:s,exports:{

     

       378
       378
       +
       PARAMS_CONTAINS:m,CLASS_REFERENCE:y},illegal:/#(?![$_A-z])/,

     

       379
       379
       +
       contains:[e.SHEBANG({label:"shebang",binary:"node",relevance:5}),{

     

       380
       380
       +
       label:"use_strict",className:"meta",relevance:10,

     

       381
       381
       +
       begin:/^\s*['"]use (strict|asm)['"]/

     

       382
       382
       +
       },e.APOS_STRING_MODE,e.QUOTE_STRING_MODE,g,d,u,b,h,{match:/\$\d+/},c,y,{

     

       383
       383
       +
       className:"attr",begin:t+n.lookahead(":"),relevance:0},O,{

     

       384
       384
       +
       begin:"("+e.RE_STARTERS_RE+"|\\b(case|return|throw)\\b)\\s*",

     

       385
       385
       +
       keywords:"return throw case",relevance:0,contains:[h,e.REGEXP_MODE,{

     

       386
       386
       +
       className:"function",begin:A,returnBegin:!0,end:"\\s*=>",contains:[{

     

       387
       387
       +
       className:"params",variants:[{begin:e.UNDERSCORE_IDENT_RE,relevance:0},{

     

       388
       388
       +
       className:null,begin:/\(\s*\)/,skip:!0},{begin:/(\s*)\(/,end:/\)/,

     

       389
       389
       +
       excludeBegin:!0,excludeEnd:!0,keywords:s,contains:m}]}]},{begin:/,/,relevance:0

     

       390
       390
       +
       },{match:/\s+/,relevance:0},{variants:[{begin:"<>",end:"</>"},{

     

       391
       391
       +
       match:/<[A-Za-z0-9\\._:-]+\s*\/>/},{begin:a.begin,

     

       392
       392
       +
       "on:begin":a.isTrulyOpeningTag,end:a.end}],subLanguage:"xml",contains:[{

     

       393
       393
       +
       begin:a.begin,end:a.end,skip:!0,contains:["self"]}]}]},w,{

     

       394
       394
       +
       beginKeywords:"while if switch catch for"},{

     

       395
       395
       +
       begin:"\\b(?!function)"+e.UNDERSCORE_IDENT_RE+"\\([^()]*(\\([^()]*(\\([^()]*\\)[^()]*)*\\)[^()]*)*\\)\\s*\\{",

     

       396
       396
       +
       returnBegin:!0,label:"func.def",contains:[_,e.inherit(e.TITLE_MODE,{begin:t,

     

       397
       397
       +
       className:"title.function"})]},{match:/\.\.\./,relevance:0},v,{match:"\\$"+t,

     

       398
       398
       +
       relevance:0},{match:[/\bconstructor(?=\s*\()/],className:{1:"title.function"},

     

       399
       399
       +
       contains:[_]},N,{relevance:0,match:/\b[A-Z][A-Z_0-9]+\b/,

     

       400
       400
       +
       className:"variable.constant"},E,x,{match:/\$[(.]/}]}},grmr_makefile:e=>{

     

       401
       401
       +
       const n={className:"variable",variants:[{

     

       402
       402
       +
       begin:"\\$\\("+e.UNDERSCORE_IDENT_RE+"\\)",contains:[e.BACKSLASH_ESCAPE]},{

     

       403
       403
       +
       begin:/\$[@%<?\^\+\*]/}]},t={className:"string",begin:/"/,end:/"/,

     

       404
       404
       +
       contains:[e.BACKSLASH_ESCAPE,n]},a={className:"variable",begin:/\$\([\w-]+\s/,

     

       405
       405
       +
       end:/\)/,keywords:{

     

       406
       406
       +
       built_in:"subst patsubst strip findstring filter filter-out sort word wordlist firstword lastword dir notdir suffix basename addsuffix addprefix join wildcard realpath abspath error warning shell origin flavor foreach if or and call eval file value"

     

       407
       407
       +
       },contains:[n]},s={begin:"^"+e.UNDERSCORE_IDENT_RE+"\\s*(?=[:+?]?=)"},i={

     

       408
       408
       +
       className:"section",begin:/^[^\s]+:/,end:/$/,contains:[n]};return{

     

       409
       409
       +
       name:"Makefile",aliases:["mk","mak","make"],keywords:{$pattern:/[\w-]+/,

     

       410
       410
       +
       keyword:"define endef undefine ifdef ifndef ifeq ifneq else endif include -include sinclude override export unexport private vpath"

     

       411
       411
       +
       },contains:[e.HASH_COMMENT_MODE,n,t,a,s,{className:"meta",begin:/^\.PHONY:/,

     

       412
       412
       +
       end:/$/,keywords:{$pattern:/[\.\w]+/,keyword:".PHONY"}},i]}},grmr_nix:e=>{

     

       413
       413
       +
       const n={

     

       414
       414
       +
       keyword:["rec","with","let","in","inherit","assert","if","else","then"],

     

       415
       415
       +
       literal:["true","false","or","and","null"],

     

       416
       416
       +
       built_in:["import","abort","baseNameOf","dirOf","isNull","builtins","map","removeAttrs","throw","toString","derivation"]

     

       417
       417
       +
       },t={className:"subst",begin:/\$\{/,end:/\}/,keywords:n},a={className:"string",

     

       418
       418
       +
       contains:[{className:"char.escape",begin:/''\$/},t],variants:[{begin:"''",

     

       419
       419
       +
       end:"''"},{begin:'"',end:'"'}]

     

       420
       420
       +
       },s=[e.NUMBER_MODE,e.HASH_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,{

     

       421
       421
       +
       begin:/[a-zA-Z0-9-_]+(\s*=)/,returnBegin:!0,relevance:0,contains:[{

     

       422
       422
       +
       className:"attr",begin:/\S+/,relevance:.2}]}];return t.contains=s,{name:"Nix",

     

       423
       423
       +
       aliases:["nixos"],keywords:n,contains:s}},grmr_python:e=>{

     

       424
       424
       +
       const n=e.regex,t=/[\p{XID_Start}_]\p{XID_Continue}*/u,a=["and","as","assert","async","await","break","case","class","continue","def","del","elif","else","except","finally","for","from","global","if","import","in","is","lambda","match","nonlocal|10","not","or","pass","raise","return","try","while","with","yield"],s={

     

       425
       425
       +
       $pattern:/[A-Za-z]\w+|__\w+__/,keyword:a,

     

       426
       426
       +
       built_in:["__import__","abs","all","any","ascii","bin","bool","breakpoint","bytearray","bytes","callable","chr","classmethod","compile","complex","delattr","dict","dir","divmod","enumerate","eval","exec","filter","float","format","frozenset","getattr","globals","hasattr","hash","help","hex","id","input","int","isinstance","issubclass","iter","len","list","locals","map","max","memoryview","min","next","object","oct","open","ord","pow","print","property","range","repr","reversed","round","set","setattr","slice","sorted","staticmethod","str","sum","super","tuple","type","vars","zip"],

     

       427
       427
       +
       literal:["__debug__","Ellipsis","False","None","NotImplemented","True"],

     

       428
       428
       +
       type:["Any","Callable","Coroutine","Dict","List","Literal","Generic","Optional","Sequence","Set","Tuple","Type","Union"]

     

       429
       429
       +
       },i={className:"meta",begin:/^(>>>|\.\.\.) /},r={className:"subst",begin:/\{/,

     

       430
       430
       +
       end:/\}/,keywords:s,illegal:/#/},o={begin:/\{\{/,relevance:0},c={

     

       431
       431
       +
       className:"string",contains:[e.BACKSLASH_ESCAPE],variants:[{

     

       432
       432
       +
       begin:/([uU]|[bB]|[rR]|[bB][rR]|[rR][bB])?'''/,end:/'''/,

     

       433
       433
       +
       contains:[e.BACKSLASH_ESCAPE,i],relevance:10},{

     

       434
       434
       +
       begin:/([uU]|[bB]|[rR]|[bB][rR]|[rR][bB])?"""/,end:/"""/,

     

       435
       435
       +
       contains:[e.BACKSLASH_ESCAPE,i],relevance:10},{

     

       436
       436
       +
       begin:/([fF][rR]|[rR][fF]|[fF])'''/,end:/'''/,

     

       437
       437
       +
       contains:[e.BACKSLASH_ESCAPE,i,o,r]},{begin:/([fF][rR]|[rR][fF]|[fF])"""/,

     

       438
       438
       +
       end:/"""/,contains:[e.BACKSLASH_ESCAPE,i,o,r]},{begin:/([uU]|[rR])'/,end:/'/,

     

       439
       439
       +
       relevance:10},{begin:/([uU]|[rR])"/,end:/"/,relevance:10},{

     

       440
       440
       +
       begin:/([bB]|[bB][rR]|[rR][bB])'/,end:/'/},{begin:/([bB]|[bB][rR]|[rR][bB])"/,

     

       441
       441
       +
       end:/"/},{begin:/([fF][rR]|[rR][fF]|[fF])'/,end:/'/,

     

       442
       442
       +
       contains:[e.BACKSLASH_ESCAPE,o,r]},{begin:/([fF][rR]|[rR][fF]|[fF])"/,end:/"/,

     

       443
       443
       +
       contains:[e.BACKSLASH_ESCAPE,o,r]},e.APOS_STRING_MODE,e.QUOTE_STRING_MODE]

     

       444
       444
       +
       },l="[0-9](_?[0-9])*",g=`(\\b(${l}))?\\.(${l})|\\b(${l})\\.`,d="\\b|"+a.join("|"),u={

     

       445
       445
       +
       className:"number",relevance:0,variants:[{

     

       446
       446
       +
       begin:`(\\b(${l})|(${g}))[eE][+-]?(${l})[jJ]?(?=${d})`},{begin:`(${g})[jJ]?`},{

     

       447
       447
       +
       begin:`\\b([1-9](_?[0-9])*|0+(_?0)*)[lLjJ]?(?=${d})`},{

     

       448
       448
       +
       begin:`\\b0[bB](_?[01])+[lL]?(?=${d})`},{begin:`\\b0[oO](_?[0-7])+[lL]?(?=${d})`

     

       449
       449
       +
       },{begin:`\\b0[xX](_?[0-9a-fA-F])+[lL]?(?=${d})`},{begin:`\\b(${l})[jJ](?=${d})`

     

       450
       450
       +
       }]},b={className:"comment",begin:n.lookahead(/# type:/),end:/$/,keywords:s,

     

       451
       451
       +
       contains:[{begin:/# type:/},{begin:/#/,end:/\b\B/,endsWithParent:!0}]},h={

     

       452
       452
       +
       className:"params",variants:[{className:"",begin:/\(\s*\)/,skip:!0},{begin:/\(/,

     

       453
       453
       +
       end:/\)/,excludeBegin:!0,excludeEnd:!0,keywords:s,

     

       454
       454
       +
       contains:["self",i,u,c,e.HASH_COMMENT_MODE]}]};return r.contains=[c,u,i],{

     

       455
       455
       +
       name:"Python",aliases:["py","gyp","ipython"],unicodeRegex:!0,keywords:s,

     

       456
       456
       +
       illegal:/(<\/|\?)|=>/,contains:[i,u,{begin:/\bself\b/},{beginKeywords:"if",

     

       457
       457
       +
       relevance:0},{match:/\bor\b/,scope:"keyword"},c,b,e.HASH_COMMENT_MODE,{

     

       458
       458
       +
       match:[/\bdef/,/\s+/,t],scope:{1:"keyword",3:"title.function"},contains:[h]},{

     

       459
       459
       +
       variants:[{match:[/\bclass/,/\s+/,t,/\s*/,/\(\s*/,t,/\s*\)/]},{

     

       460
       460
       +
       match:[/\bclass/,/\s+/,t]}],scope:{1:"keyword",3:"title.class",

     

       461
       461
       +
       6:"title.class.inherited"}},{className:"meta",begin:/^[\t ]*@/,end:/(?=#)|$/,

     

       462
       462
       +
       contains:[u,h,c]}]}},grmr_python_repl:e=>({aliases:["pycon"],contains:[{

     

       463
       463
       +
       className:"meta.prompt",starts:{end:/ |$/,starts:{end:"$",subLanguage:"python"}

     

       464
       464
       +
       },variants:[{begin:/^>>>(?=[ ]|$)/},{begin:/^\.\.\.(?=[ ]|$)/}]}]}),

     

       465
       465
       +
       grmr_rust:e=>{

     

       466
       466
       +
       const n=e.regex,t=/(r#)?/,a=n.concat(t,e.UNDERSCORE_IDENT_RE),s=n.concat(t,e.IDENT_RE),i={

     

       467
       467
       +
       className:"title.function.invoke",relevance:0,

     

       468
       468
       +
       begin:n.concat(/\b/,/(?!let|for|while|if|else|match\b)/,s,n.lookahead(/\s*\(/))

     

       469
       469
       +
       },r="([ui](8|16|32|64|128|size)|f(32|64))?",o=["drop ","Copy","Send","Sized","Sync","Drop","Fn","FnMut","FnOnce","ToOwned","Clone","Debug","PartialEq","PartialOrd","Eq","Ord","AsRef","AsMut","Into","From","Default","Iterator","Extend","IntoIterator","DoubleEndedIterator","ExactSizeIterator","SliceConcatExt","ToString","assert!","assert_eq!","bitflags!","bytes!","cfg!","col!","concat!","concat_idents!","debug_assert!","debug_assert_eq!","env!","eprintln!","panic!","file!","format!","format_args!","include_bytes!","include_str!","line!","local_data_key!","module_path!","option_env!","print!","println!","select!","stringify!","try!","unimplemented!","unreachable!","vec!","write!","writeln!","macro_rules!","assert_ne!","debug_assert_ne!"],c=["i8","i16","i32","i64","i128","isize","u8","u16","u32","u64","u128","usize","f32","f64","str","char","bool","Box","Option","Result","String","Vec"]

     

       470
       470
       +
       ;return{name:"Rust",aliases:["rs"],keywords:{$pattern:e.IDENT_RE+"!?",type:c,

     

       471
       471
       +
       keyword:["abstract","as","async","await","become","box","break","const","continue","crate","do","dyn","else","enum","extern","false","final","fn","for","if","impl","in","let","loop","macro","match","mod","move","mut","override","priv","pub","ref","return","self","Self","static","struct","super","trait","true","try","type","typeof","union","unsafe","unsized","use","virtual","where","while","yield"],

     

       472
       472
       +
       literal:["true","false","Some","None","Ok","Err"],built_in:o},illegal:"</",

     

       473
       473
       +
       contains:[e.C_LINE_COMMENT_MODE,e.COMMENT("/\\*","\\*/",{contains:["self"]

     

       474
       474
       +
       }),e.inherit(e.QUOTE_STRING_MODE,{begin:/b?"/,illegal:null}),{

     

       475
       475
       +
       className:"string",variants:[{begin:/b?r(#*)"(.|\n)*?"\1(?!#)/},{

     

       476
       476
       +
       begin:/b?'\\?(x\w{2}|u\w{4}|U\w{8}|.)'/}]},{className:"symbol",

     

       477
       477
       +
       begin:/'[a-zA-Z_][a-zA-Z0-9_]*/},{className:"number",variants:[{

     

       478
       478
       +
       begin:"\\b0b([01_]+)"+r},{begin:"\\b0o([0-7_]+)"+r},{

     

       479
       479
       +
       begin:"\\b0x([A-Fa-f0-9_]+)"+r},{

     

       480
       480
       +
       begin:"\\b(\\d[\\d_]*(\\.[0-9_]+)?([eE][+-]?[0-9_]+)?)"+r}],relevance:0},{

     

       481
       481
       +
       begin:[/fn/,/\s+/,a],className:{1:"keyword",3:"title.function"}},{

     

       482
       482
       +
       className:"meta",begin:"#!?\\[",end:"\\]",contains:[{className:"string",

     

       483
       483
       +
       begin:/"/,end:/"/,contains:[e.BACKSLASH_ESCAPE]}]},{

     

       484
       484
       +
       begin:[/let/,/\s+/,/(?:mut\s+)?/,a],className:{1:"keyword",3:"keyword",

     

       485
       485
       +
       4:"variable"}},{begin:[/for/,/\s+/,a,/\s+/,/in/],className:{1:"keyword",

     

       486
       486
       +
       3:"variable",5:"keyword"}},{begin:[/type/,/\s+/,a],className:{1:"keyword",

     

       487
       487
       +
       3:"title.class"}},{begin:[/(?:trait|enum|struct|union|impl|for)/,/\s+/,a],

     

       488
       488
       +
       className:{1:"keyword",3:"title.class"}},{begin:e.IDENT_RE+"::",keywords:{

     

       489
       489
       +
       keyword:"Self",built_in:o,type:c}},{className:"punctuation",begin:"->"},i]}}})

     

       490
       490
       +
       ;const be=ae;for(const e of Object.keys(ue)){

     

       491
       491
       +
       const n=e.replace("grmr_","").replace("_","-");be.registerLanguage(n,ue[e])}

     

       492
       492
       +
       return be}()

     

       493
       493
       +
       ;"object"==typeof exports&&"undefined"!=typeof module&&(module.exports=hljs);

-251

docs/tips_n_tricks.md

···

       1
       1
       -
       <!--

     

       2
       2
       -
         vim:fileencoding=utf-8:foldmethod=marker

     

       3
       3
       -
       -->

     

       4
       4
       -
       

     

       5
       5
       -
       # tops and bottoms

     

       6
       6
       -
       this document outlines things that i learned from various sources and some pure guesswork

     

       7
       7
       -
       

     

       8
       8
       -
       > To learn Nix is to learn to suffer, and to learn the way of numbing the pain

     

       9
       9
       -
       >

     

       10
       10
       -
       > — Cassie circa. 2023

     

       11
       11
       -
       

     

       12
       12
       -
       There might be more undocumented things. Interesting things are usually marked with `#‍ HACK:`.

     

       13
       13
       -
       

     

       14
       14
       -
       Of course, I might completely miss stuff. in that case, feel free to open an issue.

     

       15
       15
       -
       

     

       16
       16
       -
       ## overriding packages

     

       17
       17
       -
       the pill confused me and i thought i had to make overlays to do overrides but no

     

       18
       18
       -
       

     

       19
       19
       -
       in packages (i.e. `environment.systemPackages`), just do

     

       20
       20
       -
       ```nix

     

       21
       21
       -
       #-------8<-Snip-------

     

       22
       22
       -
       environment = {

     

       23
       23
       -
         systemPackages = with pkgs; [

     

       24
       24
       -
           (discord.override {withOpenASAR = true;})

     

       25
       25
       -
           ()

     

       26
       26
       -
         ];

     

       27
       27
       -
       };

     

       28
       28
       -
       #-------Snip->8-------

     

       29
       29
       -
       ```

     

       30
       30
       -
       

     

       31
       31
       -
       This works as well

     

       32
       32
       -
       ```nix

     

       33
       33
       -
       security.sudo.package = (pkgs.sudo.override {withInsults = true;});

     

       34
       34
       -
       ```

     

       35
       35
       -
       

     

       36
       36
       -
       ## overlays

     

       37
       37
       -
       overlays are useful when you want to refer to a package globally.

     

       38
       38
       -
       

     

       39
       39
       -
       the gist of overlays is as thus:

     

       40
       40
       -
       

     

       41
       41
       -
       > overlay is just `final: pref: {}` functions where dumbed down idea is

     

       42
       42
       -
       > that you do pkg = prev.pkg.override and refer to everything else from

     

       43
       43
       -
       > final

     

       44
       44
       -
       >

     

       45
       45
       -
       > idea is like final = prev // overlay(prev, final)

     

       46
       46
       -
       > (it's a recursive definition)

     

       47
       47
       -
       

     

       48
       48
       -
       (poorly made) example overlays can be found [here](https://github.com/soopyc/nixos-config/blob/master/overlays/discord-canary.nix)

     

       49
       49
       -
       

     

       50
       50
       -
       currently in-use and slightly better overlays can be found in this repo! head over to /overlays to see them.

     

       51
       51
       -
       

     

       52
       52
       -
       *note: replace `self: super:` with `final: prev:` for consistency*

     

       53
       53
       -
       

     

       54
       54
       -
       *concept and content by \@natsukagami*

     

       55
       55
       -
       

     

       56
       56
       -
       ## extra opts

     

       57
       57
       -
       a way of passing additional options globally to modules is by using extraOpts.

     

       58
       58
       -
       

     

       59
       59
       -
       in nix flakes, this is accomplished by using `specialArgs` in `nixosSystem`.

     

       60
       60
       -
       

     

       61
       61
       -
       for example, check out this line in our flake.nix:

     

       62
       62
       -
       

     

       63
       63
       -
       https://github.com/soopyc/nix-on-koumakan/blob/492dfaa01808c2aa5dbb2d8223163e92bcef673b/flake.nix#L22-L28

     

       64
       64
       -
       

     

       65
       65
       -
       this avoids the horror of `import ../../../utils/bar.nix;`

     

       66
       66
       -
       

     

       67
       67
       -
       refer to [nixpkgs:nixos/lib/eval-config.nix] and [nixpkgs:lib/modules.nix#122] for more info

     

       68
       68
       -
       

     

       69
       69
       -
       *pointers by \@natsukagami*

     

       70
       70
       -
       

     

       71
       71
       -
       ## @ (at) syntax

     

       72
       72
       -
       very simple.

     

       73
       73
       -
       

     

       74
       74
       -
       ```nix

     

       75
       75
       -
       args@{a, b, c, ...}: {

     

       76
       76
       -
         # args.a and a are the same

     

       77
       77
       -
         some = "value";

     

       78
       78
       -
       }

     

       79
       79
       -
       ```

     

       80
       80
       -
       

     

       81
       81
       -
       ## nginx regex location

     

       82
       82
       -
       ```nix

     

       83
       83
       -
       {

     

       84
       84
       -
         locations."~ \.php$".extraConfig = ''

     

       85
       85
       -
           # balls

     

       86
       86
       -
         '';

     

       87
       87
       -
       }

     

       88
       88
       -
       ```

     

       89
       89
       -
       from [nixos wiki](https://nixos.wiki/wiki/Nginx#LEMP_stack)

     

       90
       90
       -
       

     

       91
       91
       -
       ## adding a package with an overlay to a package set

     

       92
       92
       -
       

     

       93
       93
       -
       for package sets with a scope, you will have to do something like

     

       94
       94
       -
       ```nix

     

       95
       95
       -
       final: prev: {

     

       96
       96
       -
         nimPackages = prev.nimPackages.overrideScope (final': prev': {

     

       97
       97
       -
           sha1 = final'.callPackage ./sha1.nix {};

     

       98
       98
       -
           oauth = final'.callPackage ./oauth.nix {};

     

       99
       99
       -
         });

     

       100
       100
       -
       }

     

       101
       101
       -
       ```

     

       102
       102
       -
       There's an alternative method that i used to use here:

     

       103
       103
       -
       

     

       104
       104
       -
       https://github.com/soopyc/nix-on-koumakan/blob/30e65402d22b000a3b5af6c9e5ea48a2b58a54e0/overlays/nim/oauth/default.nix

     

       105
       105
       -
       

     

       106
       106
       -
       however i do not think that's the best way lol

     

       107
       107
       -
       

     

       108
       108
       -
       ## using sops-nix or other stuff to pass big chungus files to services with DynamicUser=true

     

       109
       109
       -
       afaik this is not possible.

     

       110
       110
       -
       

     

       111
       111
       -
       The option that makes the most sense, LoadCredentials only supports files up to 1 MB in size.

     

       112
       112
       -
       ([relevant documentation (`systemd.exec(5)`)](https://www.freedesktop.org/software/systemd/man/systemd.exec.html#LoadCredential=ID:PATH:~:text=Currently%2C%20an,is%20enforced))

     

       113
       113
       -
       

     

       114
       114
       -
       without that option, we are only left with giving a user access to the file. doing that is not without

     

       115
       115
       -
       its pitfalls, however. we cannot get the dynamic user's id in a ExecStartPre hook with the + prefix. The

     

       116
       116
       -
       user is ran with root privileges and there are no signs of the final ephemeral user id. the same happens with

     

       117
       117
       -
       ones prefixed with `!`.

     

       118
       118
       -
       

     

       119
       119
       -
       <!--

     

       120
       120
       -
         This is a vim fold. press z+o to open, z+c to close.

     

       121
       121
       -
         Terminal output {{{

     

       122
       122
       -
       -->

     

       123
       123
       -
       <details>

     

       124
       124
       -
         <pre>

     

       125
       125
       -
       cassie in marisa in ~ via C v13.2.1-gcc via ☕ v17.0.8 took 1s

     

       126
       126
       -
       󰁹 97% at 22:04:18 ✗ 1 ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true --property="SystemCallFilter=@system-service ~@privileged ~@resources" -pExecStartPre="+env" -pPrivateUsers=true -t bash

     

       127
       127
       -
       Running as unit: run-u1196.service

     

       128
       128
       -
       Press ^] three times within 1s to disconnect TTY.

     

       129
       129
       -
       LANG=en_US.UTF-8

     

       130
       130
       -
       PATH=/usr/local/sbin:/usr/local/bin:/usr/bin

     

       131
       131
       -
       LOGNAME=run-u1196

     

       132
       132
       -
       USER=run-u1196

     

       133
       133
       -
       INVOCATION_ID=df38607fae444d47971fa70b5f55d9a2

     

       134
       134
       -
       TERM=xterm-256color

     

       135
       135
       -
       SYSTEMD_EXEC_PID=620896

     

       136
       136
       -
       MEMORY_PRESSURE_WATCH=/sys/fs/cgroup/system.slice/run-u1196.service/memory.pressure

     

       137
       137
       -
       MEMORY_PRESSURE_WRITE=[...]

     

       138
       138
       -
       ^C%

     

       139
       139
       -
       cassie in marisa in ~ via C v13.2.1-gcc via ☕ v17.0.8 took 2s

     

       140
       140
       -
       󰁹 97% at 22:04:30 ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true --property="SystemCallFilter=@system-service ~@privileged ~@resources" -pExecStartPre="\!env" -pPrivateUsers=true -t bash

     

       141
       141
       -
       Running as unit: run-u1200.service

     

       142
       142
       -
       Press ^] three times within 1s to disconnect TTY.

     

       143
       143
       -
       LANG=en_US.UTF-8

     

       144
       144
       -
       PATH=/usr/local/sbin:/usr/local/bin:/usr/bin

     

       145
       145
       -
       LOGNAME=run-u1200

     

       146
       146
       -
       USER=run-u1200

     

       147
       147
       -
       INVOCATION_ID=f6ccef7b2d6a470aa734f0e326adb14a

     

       148
       148
       -
       TERM=xterm-256color

     

       149
       149
       -
       SYSTEMD_EXEC_PID=620992

     

       150
       150
       -
       MEMORY_PRESSURE_WATCH=/sys/fs/cgroup/system.slice/run-u1200.service/memory.pressure

     

       151
       151
       -
       MEMORY_PRESSURE_WRITE=[...]

     

       152
       152
       -
       ^C%

     

       153
       153
       -
       cassie in marisa in ~ via C v13.2.1-gcc via ☕ v17.0.8 took 2s

     

       154
       154
       -
       󰁹 97% at 22:04:42 ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true -pSystemCallFilter=@system-service -pSystemCallFilter=~@privileged -pSystemCallFilter=~@resources -pExecStartPre="\!bash -c 'echo \$UID'" -pPrivateUsers=true -t bash -c "ls"

     

       155
       155
       -
       Running as unit: run-u1236.service

     

       156
       156
       -
       Press ^] three times within 1s to disconnect TTY.

     

       157
       157
       -
       0

     

       158
       158
       -
       ^C%

     

       159
       159
       -
       cassie in marisa in ~ via C v13.2.1-gcc via ☕ v17.0.8 took 4s

     

       160
       160
       -
       󰁹 97% at 22:06:49 ➜ systemd-run -pPrivateTmp=true -pDynamicUser=true -pSystemCallFilter=@system-service -pSystemCallFilter=~@privileged -pSystemCallFilter=~@resources -pExecStartPre="+bash -c 'echo \$UID'" -pPrivateUsers=true -t bash -c "ls"

     

       161
       161
       -
       Running as unit: run-u1241.service

     

       162
       162
       -
       Press ^] three times within 1s to disconnect TTY.

     

       163
       163
       -
       0

     

       164
       164
       -
       ^C%

     

       165
       165
       -
         </pre>

     

       166
       166
       -
       </details>

     

       167
       167
       -
       

     

       168
       168
       -
       <!--

     

       169
       169
       -
         }}}

     

       170
       170
       -
       -->

     

       171
       171
       -
       

     

       172
       172
       -
       So now, we are left with the only option, which is to create a non-ephemeral user, assign it to the unit and disable DynamicUser.

     

       173
       173
       -
       This step is a little involved, you will have to add a user option to the service and forcibly disable DynamicUser.

     

       174
       174
       -
       

     

       175
       175
       -
       I opted to replace the entire module file with my own under a different name, as I had to fix a mistake in it anyways.

     

       176
       176
       -
       Here's the link to [the modified source file.](https://github.com/soopyc/mystia/blob/a999736/modules/fixups/nitter.nix)

     

       177
       177
       -
       For clarity's sake, [this is the diff of the changes made.](https://github.com/soopyc/mystia/compare/3be5eef..a999736)

     

       178
       178
       -
       

     

       179
       179
       -
       ## what the hell is an IFD??

     

       180
       180
       -
       IFD stands for import from derivation.

     

       181
       181
       -
       

     

       182
       182
       -
       *nixos/nixpkgs really need better and significantly less scattered documentation while improving manual readability.*

     

       183
       183
       -
       

     

       184
       184
       -
       # Common pitfalls

     

       185
       185
       -
       ## importing nixpkgs with an empty attrset

     

       186
       186
       -
       

     

       187
       187
       -
       ever had this in your flake.nix

     

       188
       188
       -
       

     

       189
       189
       -
       ```nix

     

       190
       190
       -
       {

     

       191
       191
       -
         outputs = { nixpkgs, ... }@inputs: let

     

       192
       192
       -
           pkgs = import nixpkgs {};

     

       193
       193
       -
           lib = nixpkgs.lib;

     

       194
       194
       -
         in {

     

       195
       195
       -
           # ...

     

       196
       196
       -
         };

     

       197
       197
       -
       }

     

       198
       198
       -
       ```

     

       199
       199
       -
       

     

       200
       200
       -
       ... and got fucked with this?

     

       201
       201
       -
       ```shell

     

       202
       202
       -
       error:

     

       203
       203
       -
              … while checking flake output 'nixosConfigurations'

     

       204
       204
       -
       

     

       205
       205
       -
                at /nix/store/lz2ra1180qfffmpwg41jpyg1z602qdgx-source/flake.nix:50:5:

     

       206
       206
       -
       

     

       207
       207
       -
                  49|   in {

     

       208
       208
       -
                  50|     nixosConfigurations = {

     

       209
       209
       -
                    |     ^

     

       210
       210
       -
                  51|       koumakan = (import ./systems/koumakan { inherit pkgs lib inputs; });

     

       211
       211
       -
       

     

       212
       212
       -
              … while checking the NixOS configuration 'nixosConfigurations.koumakan'

     

       213
       213
       -
       

     

       214
       214
       -
                at /nix/store/lz2ra1180qfffmpwg41jpyg1z602qdgx-source/flake.nix:51:7:

     

       215
       215
       -
       

     

       216
       216
       -
                  50|     nixosConfigurations = {

     

       217
       217
       -
                  51|       koumakan = (import ./systems/koumakan { inherit pkgs lib inputs; });

     

       218
       218
       -
                    |       ^

     

       219
       219
       -
                  52|     };

     

       220
       220
       -
       

     

       221
       221
       -
              (stack trace truncated; use '--show-trace' to show the full trace)

     

       222
       222
       -
       

     

       223
       223
       -
              error: attribute 'currentSystem' missing

     

       224
       224
       -
       

     

       225
       225
       -
              at /nix/store/5c0k827yjq7j24qaq8l2fcnsxp7nv8v1-source/pkgs/top-level/impure.nix:17:43:

     

       226
       226
       -
       

     

       227
       227
       -
                  16|   # (build, in GNU Autotools parlance) platform.

     

       228
       228
       -
                  17|   localSystem ? { system = args.system or builtins.currentSystem; }

     

       229
       229
       -
                    |                                           ^

     

       230
       230
       -
                  18|

     

       231
       231
       -
       ```

     

       232
       232
       -
       

     

       233
       233
       -
       just don't!!!11 remove the pkgs definition. (note that this only applies to `pkgs = import nixpkgs {};`)

     

       234
       234
       -
       

     

       235
       235
       -
       explanation

     

       236
       236
       -
       

     

       237
       237
       -
       > you shouldn't ever really import nixpkgs with an empty attrset either

     

       238
       238
       -
       >

     

       239
       239
       -
       > that causes it to fall back on guessing your system using `builtins.currentSystem`,

     

       240
       240
       -
       > which is impure and so not allowed in pure evaluation mode

     

       241
       241
       -
       >

     

       242
       242
       -
       > — \@getchoo

     

       243
       243
       -
       

     

       244
       244
       -
       # Useful links

     

       245
       245
       -
       

     

       246
       246
       -
       Builtin stdlib functions search engine: https://noogle.dev/

     

       247
       247
       -
       

     

       248
       248
       -
       

     

       249
       249
       -
       <!--links-->

     

       250
       250
       -
       [nixpkgs:lib/modules.nix#122]: https://github.com/NixOS/nixpkgs/blob/6e68daefde56a7a8e6fe7c3ca9ceeb436294bb9f/lib/modules.nix#L122

     

       251
       251
       -
       [nixpkgs:nixos/lib/eval-config.nix]: https://github.com/NixOS/nixpkgs/blob/5054472759a3b0df8e18cfe4031a5eff92d4cdc3/nixos/lib/eval-config.nix

-126

docs/utils.md

···

       1
       1
       -
       # utility functions

     

       2
       2
       -
       

     

       3
       3
       -
       ## `_utils.mkVhost`

     

       4
       4
       -
       `freeformAttrset -> freeformAttrset`

     

       5
       5
       -
       make a virtual host with sensible defaults

     

       6
       6
       -
       

     

       7
       7
       -
       pass in a set to override the defaults.

     

       8
       8
       -
       

     

       9
       9
       -
       ### Example

     

       10
       10
       -
       ```nix

     

       11
       11
       -
       services.nginx.virtualHosts."balls.example" = _utils.mkVhost {};

     

       12
       12
       -
       ```

     

       13
       13
       -
       

     

       14
       14
       -
       ## `_utils.mkSimpleProxy`

     

       15
       15
       -
       `{port, protocol, location, websockets, extraConfig} -> freeformAttrset`

     

       16
       16
       -
       

     

       17
       17
       -
       make a simple reverse proxy

     

       18
       18
       -
       

     

       19
       19
       -
       takes a set:

     

       20
       20
       -
       ```nix

     

       21
       21
       -
       {

     

       22
       22
       -
         port,

     

       23
       23
       -
         protocol ? "http",

     

       24
       24
       -
         location ? "/",

     

       25
       25
       -
         websockets ? false,

     

       26
       26
       -
         extraConfig ? {}

     

       27
       27
       -
       }

     

       28
       28
       -
       ```

     

       29
       29
       -
       

     

       30
       30
       -
       It is recommended to override/add attributes with `extraConfig` to

     

       31
       31
       -
       preserve defaults.

     

       32
       32
       -
       

     

       33
       33
       -
       Items in `extraConfig` are merged verbatim to the base attrset with defaults.

     

       34
       34
       -
       They are overridden based on their priority order.

     

       35
       35
       -
       

     

       36
       36
       -
       ## `_utils.genSecrets`

     

       37
       37
       -
       `namespace<str> -> files<list[str]> -> value<attrset> -> attrset`

     

       38
       38
       -
       

     

       39
       39
       -
       generate an attrset to be passed into sops.secrets.

     

       40
       40
       -
       

     

       41
       41
       -
       ### Example

     

       42
       42
       -
       ```nix

     

       43
       43
       -
       { _utils, ... }:

     

       44
       44
       -
       let

     

       45
       45
       -
         secrets = [

     

       46
       46
       -
           "secure_secret"

     

       47
       47
       -
           # this is a directory structure, so secrets will be stored as a file in /run/secrets/service/test/secret.

     

       48
       48
       -
           "service/test/secret"

     

       49
       49
       -
         ];

     

       50
       50
       -
       in {

     

       51
       51
       -
         sops.secrets = _utils.genSecrets "" secrets {}; # it's recommended to use a namespace, but having none is still fine.

     

       52
       52
       -
         # -> sops.secrets."secure_secret" = {};

     

       53
       53
       -
         #    sops.secrets."service/test/secret" = {};

     

       54
       54
       -
         sops.secrets = _utils.genSecrets "balls" ["balls_secret"] {owner = "balls";};

     

       55
       55
       -
         # -> sops.secrets."balls/balls_secret" = {owner = "balls";};

     

       56
       56
       -
       }

     

       57
       57
       -
       ```

     

       58
       58
       -
       

     

       59
       59
       -
       See https://github.com/soopyc/nix-on-koumakan/blob/b7983776143c15c91df69ef34ba4264a22047ec6/systems/koumakan/services/fedivese/akkoma.nix#L8-L34 for a more extensive example

     

       60
       60
       -
       

     

       61
       61
       -
       ## `_utils.setupSecrets`

     

       62
       62
       -
       `attrset<nixos config attr> -> {namespace<str> ? "", secrets[list<str>], config ? freeformAttrset} -> secretHelpers`

     

       63
       63
       -
       This is a more convoluted setup that wraps around `_utils.genSecrets` to provide some additional helper functions.

     

       64
       64
       -
       Usage of this function should make more sense than just using `genSecrets`.

     

       65
       65
       -
       

     

       66
       66
       -
       NOTE: `<ReturnValue>.generate` is not actually a function. The attrset is "already" "rendered" should it be actually

     

       67
       67
       -
       resolved by not being ignored by lazy eval.

     

       68
       68
       -
       

     

       69
       69
       -
       NOTE: does not support overriding config for only 1 path. might implement when demand arises.

     

       70
       70
       -
       

     

       71
       71
       -
       The definition of `secretHelpers` is defined as follows:

     

       72
       72
       -
       ```nix

     

       73
       73
       -
       secretHelpers = {

     

       74
       74
       -
         generate    = {}; # => {sops.secrets.* = <sopsConfig>} (inline module)

     

       75
       75
       -
         get         = path: ""; # => actual path of the secret, usually /run/secrets/the/secret

     

       76
       76
       -
       

     

       77
       77
       -
         placeholder = path: ""; # => placeholder string generated by sops-nix, for that secret path to be used in templates.

     

       78
       78
       -
         getTemplate = file: ""; # => actual path of the template, realized at activation time, similar to the get function.

     

       79
       79
       -
         mkTemplate  = file: content: {}; # => {sops.templates.* = ...;}

     

       80
       80
       -
         #             ^ => filename of the template. just an arbitrary string.

     

       81
       81
       -
       }

     

       82
       82
       -
       ```

     

       83
       83
       -
       

     

       84
       84
       -
       ### Example

     

       85
       85
       -
       ```nix

     

       86
       86
       -
       { _utils, config, ... }: let

     

       87
       87
       -
         secrets = _utils.setupSecrets config {

     

       88
       88
       -
           namespace = "balls";  # for us, the namespace is just the top level element in our secrets yaml file.

     

       89
       89
       -
           config = {

     

       90
       90
       -
             owner = "jane";

     

       91
       91
       -
           };

     

       92
       92
       -
           secrets = [ "my/definitions/gock" "my/sizes/gock" ];

     

       93
       93
       -
         };

     

       94
       94
       -
       in {

     

       95
       95
       -
         imports = [

     

       96
       96
       -
           secrets.generate

     

       97
       97
       -
           (secrets.mkTemplate "my-secret.env" ''

     

       98
       98
       -
             MY_GOCK_SIZE=${secrets.placeholder "my/sizes/gock"}

     

       99
       99
       -
           '')

     

       100
       100
       -
         ];

     

       101
       101
       -
       

     

       102
       102
       -
         some.service.settings.gock.file = secrets.get "my/definitions/gock";  # resolves to the path of balls/my/definitions/gock.

     

       103
       103
       -
         some.service.settings.envFile = secrets.getTemplate "my-secret.env";

     

       104
       104
       -
       }

     

       105
       105
       -
       ```

     

       106
       106
       -
       

     

       107
       107
       -
       ## `_utils.mkNginxFile`

     

       108
       108
       -
       `{filename<str> ? "index.html", content<str>, status<int> ? 200} -> {alias<str>, tryFiles<str>}`

     

       109
       109
       -
       Simple helper function to generate an attrset compatible with a nginx vhost `locations` attribute that serves a single file.

     

       110
       110
       -
       

     

       111
       111
       -
       ### Example

     

       112
       112
       -
       ```nix

     

       113
       113
       -
       services.nginx.virtualHosts."example.com".locations."/" = _utils.mkNginxFile {

     

       114
       114
       -
         content = ''

     

       115
       115
       -
           <!doctype html><html><body>We've been trying to reach you about your car's Extended Warranty.</body></html>

     

       116
       116
       -
         '';

     

       117
       117
       -
       };

     

       118
       118
       -
       ```

     

       119
       119
       -
       

     

       120
       120
       -
       ## `_utils.mkNginxJSON`

     

       121
       121
       -
       `filename<str> -> freeformAttrset ==> attrset`

     

       122
       122
       -
       

     

       123
       123
       -
       Simple wrapper around `_utils.mkNginxFile` that takes in an attrset and formats it as JSON.\

     

       124
       124
       -
       

     

       125
       125
       -
       Note that the function signature is different in that it doesn't take in only one attrset.

     

       126
       126
       -
       This may change in the future.