You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<spanid="docs-index"></span><h1>Skript-Manufaktur Documentation<aclass="headerlink" href="#skript-manufaktur-documentation" title="Permalink to this heading"></a></h1>
79
+
<spanid="docs-index"></span><h1>Skript-Manufaktur Documentation<aclass="headerlink" href="#skript-manufaktur-documentation" title="Link to this heading"></a></h1>
<h2>Preamble<aclass="headerlink" href="#preamble" title="Permalink to this heading"></a></h2>
83
+
<h2>Preamble<aclass="headerlink" href="#preamble" title="Link to this heading"></a></h2>
82
84
<p>This documentation is about the <codeclass="docutils literal notranslate"><spanclass="pre">Skript-Manufaktur/*</span></code> repositories. It is build with Sphinx and
83
85
<aclass="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">reStructuredText</a> plus the Read-the-Docs
84
86
theme.</p>
@@ -87,7 +89,7 @@ <h2>Preamble<a class="headerlink" href="#preamble" title="Permalink to this head
87
89
</section>
88
90
</section>
89
91
<sectionid="indices-and-tables">
90
-
<h1>Indices and tables<aclass="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1>
92
+
<h1>Indices and tables<aclass="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<spanid="docs-docker-proxy-dockerexec"></span><h1>DockerExec<aclass="headerlink" href="#dockerexec" title="Permalink to this heading"></a></h1>
100
+
<spanid="docs-docker-proxy-dockerexec"></span><h1>DockerExec<aclass="headerlink" href="#dockerexec" title="Link to this heading"></a></h1>
99
101
<p>To simplify most of the aforementioned tasks and add additional functionality for usual interactions with the
100
102
Docker-Proxy-Stack, we provice the Bash script <codeclass="docutils literal notranslate"><spanclass="pre">DockerExec</span></code>.</p>
101
103
<sectionid="advantages">
102
-
<h2>Advantages<aclass="headerlink" href="#advantages" title="Permalink to this heading"></a></h2>
104
+
<h2>Advantages<aclass="headerlink" href="#advantages" title="Link to this heading"></a></h2>
103
105
<olclass="arabic simple">
104
106
<li><p>Concise commands for Docker and Docker-Compose.</p></li>
105
107
<li><p>Perform additional tasks like stopping all local Docker containers or remove old image layers.</p></li>
@@ -111,14 +113,14 @@ <h2>Advantages<a class="headerlink" href="#advantages" title="Permalink to this
111
113
</ol>
112
114
</section>
113
115
<sectionid="how-to-use-dockerexec">
114
-
<h2>How to use DockerExec?<aclass="headerlink" href="#how-to-use-dockerexec" title="Permalink to this heading"></a></h2>
116
+
<h2>How to use DockerExec?<aclass="headerlink" href="#how-to-use-dockerexec" title="Link to this heading"></a></h2>
115
117
<olclass="arabic simple">
116
118
<li><p>Install and configure this project.</p></li>
117
119
<li><p>Try and follow <codeclass="docutils literal notranslate"><spanclass="pre">DockerExec</span><spanclass="pre">help</span></code> for a list of commands.</p></li>
118
120
</ol>
119
121
</section>
120
122
<sectionid="limitations-of-dockerexec">
121
-
<h2>Limitations of DockerExec<aclass="headerlink" href="#limitations-of-dockerexec" title="Permalink to this heading"></a></h2>
123
+
<h2>Limitations of DockerExec<aclass="headerlink" href="#limitations-of-dockerexec" title="Link to this heading"></a></h2>
122
124
<p>At this point some variables and configuration are hard coded and have to be set manually for a new project.
123
125
You also need Bash. <codeclass="docutils literal notranslate"><spanclass="pre">/bin/sh</span></code> will not suffice.</p>
124
126
<olclass="arabic simple">
@@ -137,7 +139,7 @@ <h2>Limitations of DockerExec<a class="headerlink" href="#limitations-of-dockere
137
139
</ol>
138
140
</section>
139
141
<sectionid="spawn-global-network-containers">
140
-
<spanid="docs-docker-proxy-spawn-instructions"></span><h2>Spawn global network containers<aclass="headerlink" href="#spawn-global-network-containers" title="Permalink to this heading"></a></h2>
142
+
<spanid="docs-docker-proxy-spawn-instructions"></span><h2>Spawn global network containers<aclass="headerlink" href="#spawn-global-network-containers" title="Link to this heading"></a></h2>
141
143
<p>Having the Docker-Proxy-Stack installed, you are still missing services. With its new configuration in v2, the only
142
144
container that is ensured on every init is the NGINX proxy, which will allow the basics. If you like to start a MySQL
143
145
database with your stack, you have to “spawn” and enable this container first. To do that, the
@@ -157,7 +159,7 @@ <h2>Limitations of DockerExec<a class="headerlink" href="#limitations-of-dockere
157
159
in mind to restart the Proxy-Stack, so the changes can take effect.</p>
158
160
</section>
159
161
<sectionid="a-minimal-configuration-for-php">
160
-
<spanid="docs-docker-proxy-minimal-config-php"></span><h2>A Minimal Configuration for PHP<aclass="headerlink" href="#a-minimal-configuration-for-php" title="Permalink to this heading"></a></h2>
162
+
<spanid="docs-docker-proxy-minimal-config-php"></span><h2>A Minimal Configuration for PHP<aclass="headerlink" href="#a-minimal-configuration-for-php" title="Link to this heading"></a></h2>
161
163
<p>Some environment variables cannot be read from the <codeclass="docutils literal notranslate"><spanclass="pre">.env</span></code> file and have to be man
57AE
ually added to the container under
162
164
<codeclass="docutils literal notranslate"><spanclass="pre">environment</span></code>. E.g. the domain name.</p>
@@ -217,11 +226,11 @@ <h2>Limitations of DockerExec<a class="headerlink" href="#limitations-of-dockere
217
226
POSTGRES_PASSWORD=root
218
227
</pre></div>
219
228
</div>
220
-
<p>These files can be created within any current directory with the <codeclass="docutils literal notranslate"><spanclass="pre">DockerExec</span><spanclass="pre">proxy</span><spanclass="pre">generate</span><spanclass="pre">${project-name}</span></code> command.
229
+
<p>These files can be created within any current directory using the <codeclass="docutils literal notranslate"><spanclass="pre">DockerExec</span><spanclass="pre">proxy</span><spanclass="pre">generate</span><spanclass="pre">${project-name}</span></code> command.
221
230
See <codeclass="docutils literal notranslate"><spanclass="pre">DockerExec</span><spanclass="pre">help</span></code> for better usage info.</p>
222
231
</section>
223
232
<sectionid="headstarting-the-docker-containers">
224
-
<spanid="docs-docker-proxy-headstarting-containers"></span><h2>Headstarting the Docker Containers<aclass="headerlink" href="#headstarting-the-docker-containers" title="Permalink to this heading"></a></h2>
233
+
<spanid="docs-docker-proxy-headstarting-containers"></span><h2>Headstarting the Docker Containers<aclass="headerlink" href="#headstarting-the-docker-containers" title="Link to this heading"></a></h2>
225
234
<p>Use the <codeclass="docutils literal notranslate"><spanclass="pre">START_CONTAINER</span></code> variable to define the container, that will be allocated with <codeclass="docutils literal notranslate"><spanclass="pre">docker</span><spanclass="pre">exec</span><spanclass="pre">-it</span></code> at the
226
235
end of a <codeclass="docutils literal notranslate"><spanclass="pre">DockerExec</span><spanclass="pre">(dev|prod|proxy)</span><spanclass="pre">start</span></code> command. If <codeclass="docutils literal notranslate"><spanclass="pre">START_CONTAINER=none</span></code> is set, the <codeclass="docutils literal notranslate"><spanclass="pre">docker</span><spanclass="pre">exec</span></code> will be
227
236
omitted. If not defined, it falls back to search for the first container with <codeclass="docutils literal notranslate"><spanclass="pre">-app</span></code> suffix.</p>
@@ -264,7 +273,7 @@ <h2>Limitations of DockerExec<a class="headerlink" href="#limitations-of-dockere
264
273
<hr/>
265
274
266
275
<divrole="contentinfo">
267
-
<p>© Copyright 2022, Sengorius.</p>
276
+
<p>© Copyright 2024, Sengorius.</p>
268
277
</div>
269
278
270
279
Built with <ahref="https://www.sphinx-doc.org/">Sphinx</a> using a
0 commit comments