Dockery/Pinry
1
0
Fork 0
mirror of https://github.com/pinry/pinry.git synced 2026-01-17 20:52:05 +01:00
Code Issues Packages Projects Releases Activity
Files
a18cd0f917014a23967988edf2fee7734bfb59df
Pinry/install-with-docker/index.html
winkidney 1ddb2fd45a Deployed e566b0e with MkDocs version: 1.1.2
2021-03-06 21:46:46 +08:00

613 lines
22 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Docs for the Pinry project.">
<meta name="author" content="Pinry's Contributors">
<link rel="canonical" href="https://docs.getpinry.com/install-with-docker/">
<link rel="shortcut icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.4">
<title>Install with Docker - Pinry Docs</title>
<link rel="stylesheet" href="../assets/stylesheets/main.77f3fd56.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.7fa14f5b.min.css">
<meta name="theme-color" content="#4051b5">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style>
<link rel="manifest" href="../manifest.webmanifest" crossorigin="use-credentials">
</head>
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#pinry-docker" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="https://docs.getpinry.com/" title="Pinry Docs" class="md-header__button md-logo" aria-label="Pinry Docs">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Pinry Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Install with Docker
</span>
</div>
</div>
</div>
<div class="md-header__options">
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/pinry/pinry/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
pinry/pinry
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="https://docs.getpinry.com/" title="Pinry Docs" class="md-nav__button md-logo" aria-label="Pinry Docs">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
</a>
Pinry Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/pinry/pinry/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
pinry/pinry
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item">
<a href="../screenshots/" class="md-nav__link">
Screenshots
</a>
</li>
<li class="md-nav__item">
<a href="../extensions/" class="md-nav__link">
Extensions
</a>
</li>
<li class="md-nav__item">
<a href="../theories/" class="md-nav__link">
Theories
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<a href="./" class="md-nav__link md-nav__link--active">
Install with Docker
</a>
</li>
<li class="md-nav__item">
<a href="../development/" class="md-nav__link">
Development
</a>
</li>
<li class="md-nav__item">
<a href="../plugin-system/" class="md-nav__link">
Plugin System
</a>
</li>
<li class="md-nav__item">
<a href="../upgrade-guide/" class="md-nav__link">
Upgrade Guide
</a>
</li>
<li class="md-nav__item">
<a href="../docs/" class="md-nav__link">
Docs
</a>
</li>
<li class="md-nav__item">
<a href="../passwords/" class="md-nav__link">
Passwords
</a>
</li>
<li class="md-nav__item">
<a href="../assets/" class="md-nav__link">
Assets
</a>
</li>
<li class="md-nav__item">
<a href="../contributing/" class="md-nav__link">
Contributing
</a>
</li>
<li class="md-nav__item">
<a href="../license/" class="md-nav__link">
License
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/pinry/pinry/edit/master/docs/src/install-with-docker.md" title="Edit this page" class="md-content__button md-icon">
<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>
</a>
<h1 id="pinry-docker">Pinry Docker<a class="headerlink" href="#pinry-docker" title="Permanent link">&para;</a></h1>
<p>A nice and easy way to get a Pinry instance up and running using docker. For
help on getting started with docker see the official getting started guide at
the end of this page.</p>
<h1 id="get-image-form-dockerhub">Get Image form DockerHub<a class="headerlink" href="#get-image-form-dockerhub" title="Permanent link">&para;</a></h1>
<p>The image is here: <a href="https://hub.docker.com/r/getpinry/pinry">getpinry/pinry</a>,
or you could simply pull the image from DockerHub's registry via</p>
<div class="codehilite"><pre><span></span><code>docker pull getpinry/pinry
</code></pre></div>
<p>Then use the command line like:</p>
<div class="codehilite"><pre><span></span><code><span class="c1"># this should be an abs-path not relative path like &quot;.&quot;</span>
<span class="k">export</span> <span class="n">DATA_PATH</span><span class="o">=/</span><span class="nb">abs</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">your</span><span class="o">/</span><span class="n">data</span><span class="o">/</span><span class="n">directory</span>
<span class="n">sudo</span> <span class="n">docker</span> <span class="n">run</span> <span class="o">-</span><span class="n">d</span><span class="o">=</span><span class="bp">true</span> <span class="o">-</span><span class="n">p</span><span class="o">=</span><span class="mi">80</span><span class="p">:</span><span class="mi">80</span> \
<span class="o">-</span><span class="n">v</span><span class="o">=$</span><span class="p">{</span><span class="n">DATA_PATH</span><span class="p">}:</span><span class="o">/</span><span class="n">data</span> \
<span class="n">getpinry</span><span class="o">/</span><span class="n">pinry</span>
</code></pre></div>
<h1 id="build-docker-from-source">Build Docker from Source<a class="headerlink" href="#build-docker-from-source" title="Permanent link">&para;</a></h1>
<p>Running this will get the latest version of pinry itself</p>
<div class="codehilite"><pre><span></span><code>git clone https://github.com/pinry/pinry
cd pinry/docker
./build_docker.sh
</code></pre></div>
<p>Now you can start your container by command like this</p>
<div class="codehilite"><pre><span></span><code># <span class="nv">this</span> <span class="nv">is</span> <span class="nv">where</span> <span class="nv">your</span> <span class="nv">database</span>, <span class="nv">local_settings</span> <span class="nv">and</span> <span class="nv">pins</span> <span class="nv">located</span>
<span class="nv">mkdir</span> <span class="nv">data</span>
# <span class="nv">use</span> <span class="nv">absolute</span> <span class="nv">path</span> <span class="k">for</span> <span class="nv">docker</span> <span class="nv">to</span> <span class="nv">avoid</span> <span class="nv">using</span> <span class="nv">default</span> <span class="nv">data</span><span class="o">-</span><span class="nv">volume</span> <span class="ss">(</span><span class="nv">we</span> <span class="nv">use</span> <span class="nv">directory</span> <span class="nv">instead</span><span class="ss">)</span>
.<span class="o">/</span><span class="nv">start_docker</span>.<span class="nv">sh</span> `<span class="nv">readlink</span> <span class="o">-</span><span class="nv">f</span> <span class="nv">data</span>`
</code></pre></div>
<p>Also, if you want to use a "named volume" instead, you can do this:</p>
<div class="codehilite"><pre><span></span><code>docker volume create pinry
docker run -d=true -p=80:80 \
-v pinry:/data \
getpinry/pinry
</code></pre></div>
<p>Please visit <code>http://your-ip</code> to visit your instance and register a new account, enjoy it.</p>
<h2 id="configuring-docker-pinry">Configuring docker-pinry<a class="headerlink" href="#configuring-docker-pinry" title="Permanent link">&para;</a></h2>
<hr />
<p>All the configuration files will be created
in your data folder you mounted to docker (mounted as <code>/data</code>).
If you use docker's data volume, please find the way to edit files
via <code>docker exec</code> and any way like <a href="https://stackoverflow.com/questions/47490307/editing-files-inside-of-a-docker-container">here</a>.</p>
<h3 id="enable-signups-for-new-users">Enable signups for new users<a class="headerlink" href="#enable-signups-for-new-users" title="Permanent link">&para;</a></h3>
<p>Please edit <code>/data/local_settings.py</code> in docker
and remove the container then restart it.</p>
<div class="codehilite"><pre><span></span><code>ALLOW_NEW_REGISTRATIONS = True
</code></pre></div>
<h2 id="building-docker-pinry-again-with-latest-version">Building docker-pinry again (with latest version)<a class="headerlink" href="#building-docker-pinry-again-with-latest-version" title="Permanent link">&para;</a></h2>
<p>Running this will build you a docker image with the latest version of pinry</p>
<div class="codehilite"><pre><span></span><code>git pull --rebase
cd ./docker/
./build_docker.sh
</code></pre></div>
<h1 id="backup">Backup<a class="headerlink" href="#backup" title="Permanent link">&para;</a></h1>
<p>Just copy <code>data</code> folder's content to an safe place, enjoy :)</p>
<h1 id="why-include-nginx-and-not-just-map-to-gunicorn-directly">Why include nginx and not just map to gunicorn directly?<a class="headerlink" href="#why-include-nginx-and-not-just-map-to-gunicorn-directly" title="Permanent link">&para;</a></h1>
<p>Because gunicorn/django can't serve static files very well and it is unwise to do
so for security reasons. I built this so that people can have a full hosted
solution in a container. If you have a host machine running nginx then of course
there is no point to run nginx in the container as well, you can simply disable
nginx, map gunicorn to a port and then set your host machine's nginx to display
your media and static files since that directory is shared between the container
and host.</p>
<h1 id="why-use-sqlite3">Why use sqlite3?<a class="headerlink" href="#why-use-sqlite3" title="Permanent link">&para;</a></h1>
<p>Because it has a very low resource cost and most pinry websites are small
personal ones. Why have a full on database for that? If you need more power
than you can easily modify the <code>data/local_settings.py</code> to point to a
stronger database solution ( e.g: PostgreSQL or MySQL ) .</p>
<h1 id="links">Links<a class="headerlink" href="#links" title="Permanent link">&para;</a></h1>
<ul>
<li><a href="http://www.docker.io/gettingstarted/">official getting started guide</a></li>
<li><a href="https://github.com/pinry/pinry/blob/master/pinry/settings/local_settings.example.py">additional pinry configuration settings</a></li>
</ul>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="../theories/" class="md-footer__link md-footer__link--prev" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
Theories
</div>
</div>
</a>
<a href="../development/" class="md-footer__link md-footer__link--next" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Development
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
<div class="md-footer-copyright__highlight">
Copyright &copy; 2019 Pinry's Contributors
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-footer-social">
<a href="https://github.com/sundowndev/PhoneInfoga" target="_blank" rel="noopener" title="github.com" class="md-footer-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 480 512"><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../assets/javascripts/workers/search.fb4a9340.min.js", "version": null}</script>
<script src="../assets/javascripts/bundle.9b151c6a.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink