<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - +/garnix-minecraft @ main</title>
<meta name="description" content="README.md in +/garnix-minecraft at main.">
<meta property="og:title" content="README.md - +/garnix-minecraft @ main">
<meta property="og:description" content="README.md in +/garnix-minecraft at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="95bf3c2ad5bfd54824c37ae22555f9054946b424">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>+/garnix-minecraft</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/+/garnix-minecraft</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Julia Ryan</span><span class="commit-message" data-commit="95bf3c2ad5bfd54824c37ae22555f9054946b424">Add nix-minecraft</span><span class="snapshot-sha sha" data-commit="95bf3c2ad5bfd54824c37ae22555f9054946b424">95bf3c2</span><time datetime="2024-10-27T19:16:18+01:00" title="2024-10-27 19:16:18 +0100">2024-10-27</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/%2B/garnix-minecraft/ref/main/">main</a><a class="all" href="/%2B/garnix-minecraft/refs">all refs →</a></div></details><nav class="crumbs"><a href="/%2B/garnix-minecraft/">garnix-minecraft</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>865 B</span><span>19 lines</span></span><span class="actions"><a class="raw" href="/%2B/garnix-minecraft/raw/59c58a669f0e97d2c72c51a18bfbf465e6ccd64f/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>template-minecraft</h1>
<p>A garnix-compatible repo for deploying your own minecraft server</p>
<p>To get your own minecraft server going:</p>
<ol>
<li>Create a <a href="https://garnix.io">garnix</a> account if you don't have one yet.</li>
<li>Fork this repo.</li>
<li>Make sure the garnix GitHub App is enabled on this repo.</li>
<li>Update the host name in the server config
<a href="https://github.com/p1n3appl3/garnix-minecraft/blob/main/flake.nix">./hosts/server.nix</a>.</li>
<li>[Optional] Add your public ssh key in
<a href="https://github.com/p1n3appl3/garnix-minecraft/blob/main/flake.nix">./hosts/server.nix</a>.
This will allow you to ssh into your deployed host.</li>
<li>Push your changes! garnix will build and deploy the package, and make your
server available in a <code>garnix.me</code> domain.</li>
</ol>
<p>This <a href="https://server.main.template-rss-bridge.garnix-io.garnix.me">RSS Bridge Server</a> gets deployed
automatically with this repository.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>template-minecraft</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">A garnix-compatible repo for deploying your own minecraft server</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">To get your own minecraft server going:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>1) </a-p>Create a [garnix](https://garnix.io) account if you don&#39;t have one yet.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>2) </a-p>Fork this repo.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>3) </a-p>Make sure the garnix GitHub App is enabled on this repo.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>4) </a-p>Update the host name in the server config</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">  [./hosts/server.nix](https://github.com/p1n3appl3/garnix-minecraft/blob/main/flake.nix).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>5) </a-p>[Optional] Add your public ssh key in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">  [./hosts/server.nix](https://github.com/p1n3appl3/garnix-minecraft/blob/main/flake.nix).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">  This will allow you to ssh into your deployed host.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>6) </a-p>Push your changes! garnix will build and deploy the package, and make your</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>   </a-p>server available in a `garnix.me` domain.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">This [RSS Bridge Server](https://server.main.template-rss-bridge.garnix-io.garnix.me) gets deployed</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">automatically with this repository.</span></span></pre></div></div>
</main>
</body>
</html>
