Dockery/Pinry
1
0
Fork 0
mirror of https://github.com/pinry/pinry.git synced 2026-02-27 08:41:02 +01:00
Code Issues Packages Projects Releases Activity

Deployed c6514ef with MkDocs version: 1.0.4

Browse Source
This commit is contained in:
winkidney
2020-02-14 17:29:32 +08:00
parent ca221f7eaa
commit 4be47fcf53
21 changed files with 231 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
404.html
View File

@@ -272,8 +272,8 @@
<li class="md-nav__item">
<a href="/install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="/install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

4
assets/index.html
View File

@@ -278,8 +278,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

4
contributing/index.html
View File

@@ -278,8 +278,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

104
development/index.html
View File

@@ -278,8 +278,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>
@@ -298,10 +298,39 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
Development
</label>
<a href="./" title="Development" class="md-nav__link md-nav__link--active">
Development
</a>
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#testing" class="md-nav__link">
Testing
</a>
</li>
</ul>
</nav>
</li>
@@ -382,6 +411,22 @@
<label class="md-nav__title" for="__toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#testing" class="md-nav__link">
Testing
</a>
</li>
</ul>
</nav>
</div>
</div>
@@ -430,6 +475,57 @@ backend:</p>
<p>And from another terminal:</p>
<div class="codehilite"><pre><span></span><span class="err">cd pinry-spa; yarn serve</span>
</pre></div>
<h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permanent link">&para;</a></h2>
<p>We have many tests built into Pinry to ensure that changes don't break
anything. If you are live dangerously and have cutting edge new Pinry
features first you can use our master branch for your own instance. We
recommend using our tags/versions though.</p>
<p>To run Pinry's tests inside the Pinry repo run:</p>
<div class="codehilite"><pre><span></span><span class="err">pipenv run python manage.py test</span>
</pre></div>
<h1 id="docker">Docker<a class="headerlink" href="#docker" title="Permanent link">&para;</a></h1>
<p>Follow the steps below to install Pinry locally or on any server. This
process installs the minimal requirements to run Pinry. For development
requirements and procedures, see testing above.</p>
<p>Current docker configuration will just mount source code directory to
docker app directory and run any codes existed in current git branch,
you may also add "local_settings.py" to customize settings without
changing settings file in <code>pinry/settings</code>.</p>
<ul>
<li>
<p>Install the requirements:</p>
<ul>
<li>Docker</li>
<li>Docker Compose</li>
</ul>
</li>
<li>
<p>Set any custom configuration options you need and run::</p>
</li>
</ul>
<p>cp docker-compose.example.yml docker-compose.yml<br />
# edit docker-compose.yml and change the secret-key,<br />
# don't forget to backup this config file.<br />
# You should build frontend first<br />
docker-compose up build_frontend<br />
# then start the backend server<br />
docker-compose up -d web</p>
<ul>
<li>
<p>If you want to run Pinry with current user in docker::</p>
<p>./start_docker_with_current_user.sh [-d]</p>
</li>
<li>
<p>Bootstrap the database(optional)::</p>
<p>docker-compose exec web python3 manage.py migrate --settings=pinry.settings.docker</p>
</li>
</ul>
<p><strong>Note</strong> : No static file server configured, your should configure nginx or other server to serve
static files from <code>./static</code>(as path <code>/static</code>) and <code>./pinry-spa/dist</code> (as html root <code>/</code>)</p>
@@ -450,7 +546,7 @@ backend:</p>
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../install-with-docker/" title="Install with Docker" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
</div>
@@ -459,7 +555,7 @@ backend:</p>
<span class="md-footer-nav__direction">
Previous
</span>
InstallWithDocker
Install with Docker
</span>
</div>
</a>

4
docs/index.html
View File

@@ -278,8 +278,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

4
extensions/index.html
View File

@@ -287,8 +287,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

BIN
imgs/screenshots/home.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 106 KiB

BIN
imgs/screenshots/my_boards.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

BIN
imgs/screenshots/my_pin.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 83 KiB

BIN
imgs/screenshots/new_pin.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
imgs/screenshots/pin_detail.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.4 MiB

BIN
imgs/screenshots/search.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.8 MiB

4
index.html
View File

@@ -323,8 +323,8 @@
<li class="md-nav__item">
<a href="install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

8
install-with-docker/index.html
View File

@@ -42,7 +42,7 @@
<title>InstallWithDocker - Pinry Docs</title>
<title>Install with Docker - Pinry Docs</title>
@@ -119,7 +119,7 @@
</span>
<span class="md-header-nav__topic">
InstallWithDocker
Install with Docker
</span>
@@ -286,8 +286,8 @@
<a href="./" title="InstallWithDocker" class="md-nav__link md-nav__link--active">
InstallWithDocker
<a href="./" title="Install with Docker" class="md-nav__link md-nav__link--active">
Install with Docker
</a>
</li>

4
license/index.html
View File

@@ -278,8 +278,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

4
passwords/index.html
View File

@@ -278,8 +278,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>

98
screenshots/index.html
View File

@@ -275,6 +275,47 @@
</li>
<li class="md-nav__item">
<a href="#boards" class="md-nav__link">
Boards
</a>
</li>
<li class="md-nav__item">
<a href="#pins" class="md-nav__link">
Pins
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-pin" class="md-nav__link">
Create Pin
</a>
</li>
<li class="md-nav__item">
<a href="#pin-large-view" class="md-nav__link">
Pin large-view
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#searchfilter" class="md-nav__link">
Search/Filter
</a>
</li>
@@ -316,8 +357,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>
@@ -421,6 +462,47 @@
</li>
<li class="md-nav__item">
<a href="#boards" class="md-nav__link">
Boards
</a>
</li>
<li class="md-nav__item">
<a href="#pins" class="md-nav__link">
Pins
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-pin" class="md-nav__link">
Create Pin
</a>
</li>
<li class="md-nav__item">
<a href="#pin-large-view" class="md-nav__link">
Pin large-view
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#searchfilter" class="md-nav__link">
Search/Filter
</a>
</li>
@@ -445,7 +527,17 @@
will be more screenshots in the future. You could always try our demo that
we mention on the first page of the docs.</p>
<h2 id="home">Home<a class="headerlink" href="#home" title="Permanent link">&para;</a></h2>
<p><img alt="Home" src="../imgs/screenshot.png" /></p>
<p><img alt="Home" src="../imgs/screenshots/home.jpg" /></p>
<h2 id="boards">Boards<a class="headerlink" href="#boards" title="Permanent link">&para;</a></h2>
<p><img alt="Boards" src="../imgs/screenshots/my_boards.jpg" /></p>
<h2 id="pins">Pins<a class="headerlink" href="#pins" title="Permanent link">&para;</a></h2>
<p><img alt="Pins" src="../imgs/screenshots/my_pin.jpg" /></p>
<h3 id="create-pin">Create Pin<a class="headerlink" href="#create-pin" title="Permanent link">&para;</a></h3>
<p><img alt="Create Pin" src="../imgs/screenshots/new_pin.jpg" /></p>
<h3 id="pin-large-view">Pin large-view<a class="headerlink" href="#pin-large-view" title="Permanent link">&para;</a></h3>
<p><img alt="Large View" src="../imgs/screenshots/pin_detail.png" /></p>
<h2 id="searchfilter">Search/Filter<a class="headerlink" href="#searchfilter" title="Permanent link">&para;</a></h2>
<p><img alt="Home" src="../imgs/screenshots/search.gif" /></p>

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

22
sitemap.xml
View File

@@ -2,57 +2,57 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.getpinry.com/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/screenshots/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/extensions/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/theories/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/install-with-docker/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/development/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/docs/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/passwords/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/assets/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/contributing/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://docs.getpinry.com/license/</loc>
<lastmod>2019-12-20</lastmod>
<lastmod>2020-02-14</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.

8
theories/index.html
View File

@@ -316,8 +316,8 @@
<li class="md-nav__item">
<a href="../install-with-docker/" title="InstallWithDocker" class="md-nav__link">
InstallWithDocker
<a href="../install-with-docker/" title="Install with Docker" class="md-nav__link">
Install with Docker
</a>
</li>
@@ -484,13 +484,13 @@ instead of "tag" which designed for all users.</p>
</a>
<a href="../install-with-docker/" title="InstallWithDocker" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../install-with-docker/" title="Install with Docker" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
InstallWithDocker
Install with Docker
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">