knadh/listmonk
1
1
Fork 0
mirror of https://github.com/knadh/listmonk.git synced 2025-11-09 17:22:26 +08:00
Code Issues Projects Releases Packages Wiki Activity

deploy: 5664e5cc9f

Browse source
This commit is contained in:
github-actions[bot] 2023-08-28 14:43:50 +00:00
parent 1b6a646a5b
commit b99f3f19c5
24 changed files with 39 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/404.html
View file

@ -12,7 +12,7 @@
<link rel="icon" href="/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/apis/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/campaigns/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/import/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/lists/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/media/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/subscribers/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/templates/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/apis/transactional/index.html
View file

@ -14,7 +14,7 @@
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/archives/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/bounces/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/concepts/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

4
docs/configuration/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">
@ -985,7 +985,7 @@
<h2 id="media-uploads">Media Uploads<a class="headerlink" href="#media-uploads" title="Permanent link">&para;</a></h2>
<h3 id="filesystem">Filesystem<a class="headerlink" href="#filesystem" title="Permanent link">&para;</a></h3>
<p>When configuring <code>docker</code> volume mounts for using filesystem media uploads, you can follow either of two approaches. <a href="https://github.com/knadh/listmonk/issues/1169#issuecomment-1674475945">The second option may be necessary if</a> your setup requires you to use <code>sudo</code> for docker commands. </p>
<p>After making any changes you will need to run <code>sudo docker-compose stop ; sudo docker-compose up</code>. </p>
<p>After making any changes you will need to run <code>sudo docker compose stop ; sudo docker compose up</code>. </p>
<p>And under <code>https://listmonk.mysite.com/admin/settings</code> you put <code>/listmonk/uploads</code>. </p>
<h4 id="using-volumes">Using volumes<a class="headerlink" href="#using-volumes" title="Permanent link">&para;</a></h4>
<p>Using <code>docker volumes</code>, you can specify the name of volume and destination for the files to be uploaded inside the container.</p>

4
docs/developer-setup/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">
@ -720,7 +720,7 @@
<ul>
<li><code>go</code></li>
<li><code>nodejs</code> (if you are working on the frontend) and <code>yarn</code></li>
<li>Postgres database. If there is no local installation, the demo docker DB can be used for development (<code>docker-compose up demo-db</code>)</li>
<li>Postgres database. If there is no local installation, the demo docker DB can be used for development (<code>docker compose up demo-db</code>)</li>
</ul>
<h3 id="first-time-setup">First time setup<a class="headerlink" href="#first-time-setup" title="Permanent link">&para;</a></h3>
<p><code>git clone https://github.com/knadh/listmonk.git</code>. The project uses go.mod, so it's best to clone it outside the Go src path.</p>

2
docs/external-integration/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/i18n/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/index.html
View file

@ -14,7 +14,7 @@
<link rel="icon" href="images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

18
docs/installation/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">
@ -914,7 +914,7 @@
</ul>
<h2 id="docker">Docker<a class="headerlink" href="#docker" title="Permanent link">&para;</a></h2>
<p>The latest image is available on DockerHub at <code>listmonk/listmonk:latest</code></p>
<p>Use the sample <a href="https://github.com/knadh/listmonk/blob/master/docker-compose.yml">docker-compose.yml</a> to run listmonk and Postgres DB with docker-compose as follows:</p>
<p>Use the sample <a href="https://github.com/knadh/listmonk/blob/master/docker-compose.yml">docker-compose.yml</a> to run listmonk and Postgres DB with <code>docker compose</code> as follows:</p>
<h3 id="demo">Demo<a class="headerlink" href="#demo" title="Permanent link">&para;</a></h3>
<h4 id="easy-docker-install">Easy Docker install<a class="headerlink" href="#easy-docker-install" title="Permanent link">&para;</a></h4>
<div class="highlight"><pre><span></span><code>mkdir<span class="w"> </span>listmonk-demo
@ -922,7 +922,7 @@ sh<span class="w"> </span>-c<span class="w"> </span><span class="s2">&quot;</spa
</code></pre></div>
<h4 id="manual-docker-install">Manual Docker install<a class="headerlink" href="#manual-docker-install" title="Permanent link">&para;</a></h4>
<div class="highlight"><pre><span></span><code>wget<span class="w"> </span>-O<span class="w"> </span>docker-compose.yml<span class="w"> </span>https://raw.githubusercontent.com/knadh/listmonk/master/docker-compose.yml
docker-compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>demo-db<span class="w"> </span>demo-app
docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>demo-db<span class="w"> </span>demo-app
</code></pre></div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
@ -945,16 +945,16 @@ sh<span class="w"> </span>-c<span class="w"> </span><span class="s2">&quot;</spa
<p>It's recommended to examine the contents of the shell script, before running in your environment.</p>
</div>
<h4 id="manual-docker-install_1">Manual Docker install<a class="headerlink" href="#manual-docker-install_1" title="Permanent link">&para;</a></h4>
<p>The following workflow is recommended to setup <code>listmonk</code> manually using <code>docker-compose</code>. You are encouraged to customise the contents of <code>docker-compose.yml</code> to your needs. The overall setup looks like:</p>
<p>The following workflow is recommended to setup <code>listmonk</code> manually using <code>docker compose</code>. You are encouraged to customise the contents of <code>docker-compose.yml</code> to your needs. The overall setup looks like:</p>
<ul>
<li><code>docker-compose up db</code> to run the Postgres DB.</li>
<li><code>docker-compose run --rm app ./listmonk --install</code> to setup the DB (or <code>--upgrade</code> to upgrade an existing DB).</li>
<li><code>docker compose up db</code> to run the Postgres DB.</li>
<li><code>docker compose run --rm app ./listmonk --install</code> to setup the DB (or <code>--upgrade</code> to upgrade an existing DB).</li>
<li>Copy <code>config.toml.sample</code> to your directory and make the following changes:<ul>
<li><code>app.address</code> =&gt; <code>0.0.0.0:9000</code> (Port forwarding on Docker will work only if the app is advertising on all interfaces.)</li>
<li><code>db.host</code> =&gt; <code>listmonk_db</code> (Container Name of the DB container)</li>
</ul>
</li>
<li>Run <code>docker-compose up app</code> and visit <code>http://localhost:9000</code>.</li>
<li>Run <code>docker compose up app</code> and visit <code>http://localhost:9000</code>.</li>
</ul>
<h5 id="mounting-a-custom-configtoml">Mounting a custom config.toml<a class="headerlink" href="#mounting-a-custom-configtoml" title="Permanent link">&para;</a></h5>
<p>To mount a local <code>config.toml</code> file, add the following section to <code>docker-compose.yml</code>:</p>
@ -996,13 +996,13 @@ sh<span class="w"> </span>-c<span class="w"> </span><span class="s2">&quot;</spa
<p class="admonition-title">Tip</p>
<ul>
<li>See <a href="../configuration">configuring with environment variables</a> for variables like <code>app.admin_password</code> and <code>db.password</code></li>
<li>Ensure that both <code>app</code> and <code>db</code> containers are in running. If the containers are not running, restart them <code>docker-compose restart app db</code>.</li>
<li>Ensure that both <code>app</code> and <code>db</code> containers are in running. If the containers are not running, restart them <code>docker compose restart app db</code>.</li>
<li>Refer to <a href="https://yasoob.me/posts/setting-up-listmonk-opensource-newsletter-mailing/">this tutorial</a> for setting up a production instance with Docker + Nginx + LetsEncrypt SSL.</li>
</ul>
</div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>The example <code>docker-compose.yml</code> file works with Docker Engine 18.06.0+ and <code>docker-compose</code> which supports file format 3.7.</p>
<p>The example <code>docker-compose.yml</code> file works with Docker Engine 24.0.5+ and Docker Compose version v2.20.2+.</p>
</div>
<h2 id="compiling-from-source">Compiling from source<a class="headerlink" href="#compiling-from-source" title="Permanent link">&para;</a></h2>
<p>To compile the latest unreleased version (<code>master</code> branch):</p>

2
docs/messengers/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/querying-and-segmentation/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

2
docs/search/search_index.json
View file

File diff suppressed because one or more lines are too long

BIN
docs/sitemap.xml.gz
View file

Binary file not shown.

2
docs/templating/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">

14
docs/upgrade/index.html
View file

@ -16,7 +16,7 @@
<link rel="icon" href="../images/favicon.png">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.4">
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">
@ -738,9 +738,9 @@
</ul>
<h2 id="docker">Docker<a class="headerlink" href="#docker" title="Permanent link">&para;</a></h2>
<ul>
<li><code>docker-compose pull</code> to pull the latest version from DockerHub.</li>
<li><code>docker-compose run --rm app ./listmonk --upgrade</code> to upgrade an existing DB.</li>
<li>Run <code>docker-compose up app db</code> and visit <code>http://localhost:9000</code>.</li>
<li><code>docker compose pull</code> to pull the latest version from DockerHub.</li>
<li><code>docker compose run --rm app ./listmonk --upgrade</code> to upgrade an existing DB.</li>
<li>Run <code>docker compose up app db</code> and visit <code>http://localhost:9000</code>.</li>
</ul>
<h2 id="railway">Railway<a class="headerlink" href="#railway" title="Permanent link">&para;</a></h2>
<ul>
@ -755,13 +755,13 @@
<ol>
<li>Stop listmonk.</li>
<li>Restore your pre-upgrade database.</li>
<li>If you're using docker-compose, edit <code>docker-compose.yml</code> and change <code>listmonk:latest</code> to <code>listmonk:v2.4.0</code> <em>(for example)</em>.</li>
<li>If you're using <code>docker compose</code>, edit <code>docker-compose.yml</code> and change <code>listmonk:latest</code> to <code>listmonk:v2.4.0</code> <em>(for example)</em>.</li>
<li>Restart.</li>
</ol>
<p><strong>Example with docker:</strong></p>
<ol>
<li>Stop listmonk (app):
<div class="highlight"><pre><span></span><code>sudo docker container stop listmonk_app
<div class="highlight"><pre><span></span><code>sudo docker stop listmonk_app
</code></pre></div></li>
<li>Restore your pre-upgrade db (required) <em>(be careful, this will wipe your existing DB)</em>:
<div class="highlight"><pre><span></span><code>psql -h 127.0.0.1 -p 9432 -U listmonk
@ -776,7 +776,7 @@ psql -h 127.0.0.1 -p 9432 -U listmonk -W listmonk &lt; listmonk-preupgrade-db.sq
image: listmonk/listmonk:v2.4.0
</code></pre></div></li>
<li>Restart:
<code>sudo docker-compose up -d app db nginx certbot</code></li>
<code>sudo docker compose up -d app db nginx certbot</code></li>
</ol>