Deploying to gh-pages from @ TxtDot/documentation@ea47bafb84 🚀

docker/index.html

@@ -387,17 +387,16 @@
 
 <h1 id="docker">Docker</h1>
 <p>If you prefer hosting without Docker, see <a href="../selfhost/">Self-Hosting</a> instead.</p>
-<p>Docker Engine and Docker Compose are required.</p>
+<p>Download docker-compose.yml and txtdot configs,
-<p>Note that built images are not provided via Docker Hub.
+edit them and then start the container:</p>
-If you can't or don't want to build them on your server
+<pre><code class="language-bash">wget https://raw.githubusercontent.com/TxtDot/txtdot/main/docker-compose.yml
-and don't want to setup a CI/CD system,
+wget -O .env https://raw.githubusercontent.com/TxtDot/txtdot/main/.env.example
-<a href="https://github.com/txtdot/txtdot/issues">let us know</a>,
+nano .env
-we'll consider setting up a GitHub Actions workflow.</p>
-<pre><code class="language-bash">git clone https://github.com/txtdot/txtdot.git
-cd txtdot
-docker compose build
 docker compose up -d
 </code></pre>
+<p>Alternatively, you can configure txtdot with
+the <code>environment</code> section of docker-compose config
+(don't forget to remove .env and <code>volumes</code>).</p>
 
 
 

env/index.html

@@ -371,6 +371,20 @@
     REVERSE_PROXY
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#proxy_res" class="md-nav__link">
+    PROXY_RES
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#swagger" class="md-nav__link">
+    SWAGGER
+  </a>
+  
 </li>
       
     </ul>
@@ -445,6 +459,20 @@
     REVERSE_PROXY
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#proxy_res" class="md-nav__link">
+    PROXY_RES
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#swagger" class="md-nav__link">
+    SWAGGER
+  </a>
+  
 </li>
       
     </ul>
@@ -481,6 +509,13 @@ Set it to <code>127.0.0.1</code> if your txtdot instance is behind reverse proxy
 <p>Default: <code>false</code></p>
 <p>Set it to <code>true</code> only if your txtdot instance runs behind reverse proxy.
 Needed for processing X-Forwarded headers.</p>
+<h2 id="proxy_res">PROXY_RES</h2>
+<p>Default: <code>true</code></p>
+<p>Whether to allow proxying images, video, audio
+and everything else through your txtdot instance.</p>
+<h2 id="swagger">SWAGGER</h2>
+<p>Default: <code>false</code></p>
+<p>Whether to add <code>/doc</code> route for Swagger API docs.</p>