Skip to content

Commit

Permalink
Deployed 3b462cb with MkDocs version: 1.5.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@mgineer85
mgineer85 committed Oct 5, 2023
1 parent 5bedc3e commit dcc0333
Show file tree
Hide file tree
Showing 6 changed files with 114 additions and 36 deletions.
2 changes: 1 addition & 1 deletion reference/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@
<article class="md-content__inner md-typeset">
<h1 id="http-api">HTTP API</h1>
<p>Following HTTP api is provided by the photobooth app.</p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="7b7eb739" src="swagger-7b7eb739.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="f9d4e3ac" src="swagger-f9d4e3ac.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
</article>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion reference/api/swagger-7b7eb739.html → reference/api/swagger-f9d4e3ac.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("7b7eb739");
parent.update_swagger_ui_iframe_height("f9d4e3ac");
});

// start observing for resizing
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

79 changes: 59 additions & 20 deletions setup/shareservice/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,18 +274,25 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#working-principle">
Working Principle
<a class="md-nav__link" href="#options-to-share-via-qr-code">
Options to share via QR code
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#batteries-included-shareservice">
Batteries included shareservice
</a>
<nav aria-label="Working Principle" class="md-nav">
<nav aria-label="Batteries included shareservice" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#benefits">
Benefits
</a>
</li>
</ul>
</nav>
<li class="md-nav__item">
<a class="md-nav__link" href="#working-principle">
Working Principle
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#setup">
Expand All @@ -301,6 +308,14 @@
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#use-your-own-sharing-solution">
Use your own sharing solution
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="../printing/">
Printing
</a>
Expand Down Expand Up @@ -429,18 +444,25 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix="">
<li class="md-nav__item">
<a class="md-nav__link" href="#working-principle">
Working Principle
<a class="md-nav__link" href="#options-to-share-via-qr-code">
Options to share via QR code
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#batteries-included-shareservice">
Batteries included shareservice
</a>
<nav aria-label="Working Principle" class="md-nav">
<nav aria-label="Batteries included shareservice" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#benefits">
Benefits
</a>
</li>
</ul>
</nav>
<li class="md-nav__item">
<a class="md-nav__link" href="#working-principle">
Working Principle
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#setup">
Expand All @@ -454,6 +476,14 @@
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#use-your-own-sharing-solution">
Use your own sharing solution
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
Expand All @@ -467,7 +497,20 @@ <h1 id="share-images-via-qr-code">Share images via QR Code</h1>
</p>
<figcaption>Scan the QR code to download image to smartphones.</figcaption>
</figure>
<h2 id="working-principle">Working Principle</h2>
<h2 id="options-to-share-via-qr-code">Options to share via QR code</h2>
<ol>
<li>Use the batteries included shareservice.</li>
<li>Sync images (on your own) and provide a custom URL users can download images</li>
</ol>
<h2 id="batteries-included-shareservice">Batteries included shareservice</h2>
<h3 id="benefits">Benefits</h3>
<ul>
<li>secure: the photobooth does not need to expose a service to the internet</li>
<li>saves data: only images that are requested via QR code are transferred via internet</li>
<li>works also with cellular internet service that usually provide no public ip address</li>
<li>simple: just one php file to setup</li>
</ul>
<h3 id="working-principle">Working Principle</h3>
<p>It's developed with ease of use in mind and shall work on most systems even with firewalled internet connection on photobooth side like cellular services.
Once setup, the prinicple is as following:</p>
<ul>
Expand All @@ -476,14 +519,7 @@ <h2 id="working-principle">Working Principle</h2>
<li>the photobooth uploads the requested file</li>
<li>once upload is finished, the image is displayed to the user</li>
</ul>
<h3 id="benefits">Benefits</h3>
<ul>
<li>secure: the photobooth does not need to expose a service to the internet</li>
<li>saves data: only images that are requested via QR code are transferred via internet</li>
<li>works also with cellular internet service that usually provide no public ip address</li>
<li>simple: just one php file to setup</li>
</ul>
<h2 id="setup">Setup</h2>
<h3 id="setup">Setup</h3>
<ul>
<li><a href="https://github.com/mgrl/photobooth-app/blob/main/extras/shareservice/dl.php">download dl.php</a></li>
<li>edit the config variables on top of dl.php. see the comments in dl.php for reference.</li>
Expand All @@ -496,11 +532,14 @@ <h2 id="setup">Setup</h2>
</li>
<li>Now restart the photobooth app and try to scan a QR code in the gallery.</li>
</ul>
<h2 id="troubleshooting">Troubleshooting</h2>
<h3 id="troubleshooting">Troubleshooting</h3>
<ul>
<li>check php error log in the folder where dl.php is located</li>
<li>check photobooth error log</li>
</ul>
<h2 id="use-your-own-sharing-solution">Use your own sharing solution</h2>
<p>If the shareservice is not what you want, you can synchronize the data folder manually and share a link to the images.
The QR code is pointing to an URL that needs to be accessible by the users smartphone. This is possible if the user connects to a local hotspot in the same network as the photobooth computer or the files can be uploaded to the internet to make them accessible.</p>
</article>
</div>
</div>
Expand Down
Binary file modified sitemap.xml.gz
View file
Binary file not shown.
65 changes: 52 additions & 13 deletions support/troubleshooting/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,20 @@
<a class="md-nav__link" href="#photobooth-app-website-not-available">
Photobooth app website not available
</a>
<nav aria-label="Photobooth app website not available" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#gather-information-to-troubleshoot">
Gather information to troubleshoot
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#manually-start-the-app">
Manually start the app
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#photobooth-command-not-found">
Expand Down Expand Up @@ -428,6 +442,20 @@
<a class="md-nav__link" href="#photobooth-app-website-not-available">
Photobooth app website not available
</a>
<nav aria-label="Photobooth app website not available" class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a class="md-nav__link" href="#gather-information-to-troubleshoot">
Gather information to troubleshoot
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#manually-start-the-app">
Manually start the app
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#photobooth-command-not-found">
Expand All @@ -453,8 +481,8 @@
<article class="md-content__inner md-typeset">
<h1 id="troubleshooting">Troubleshooting</h1>
<h2 id="photobooth-app-website-not-available">Photobooth app website not available</h2>
<p>In default configuration the app listens to 0.0.0.0:8000,
so it can be reached from every computer in the same network on port 8000.</p>
<p>In default configuration the app listens to port 8000,
so it can be reached from every computer in the same network on port 8000. On the same computer go to <a href="http://localhost:8000">http://localhost:8000</a>.</p>
<p>If the website is not available, the reason could be</p>
<ul>
<li>network issues or</li>
Expand All @@ -463,33 +491,44 @@ <h2 id="photobooth-app-website-not-available">Photobooth app website not availab
<p>Check that the website is available on the device itself via <a href="http://localhost:8000">http://localhost:8000</a>.
If that works, the issue is about the network.</p>
<p>If not, the app might have crashed.</p>
<h3 id="gather-information-to-troubleshoot">Gather information to troubleshoot</h3>
<p>The following commands help tracking down issues and gather information:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># logfiles from service (last 200 lines)</span>
journalctl<span class="w"> </span>--user<span class="w"> </span>--unit<span class="o">=</span>photobooth-app<span class="w"> </span>-n<span class="w"> </span><span class="m">200</span><span class="w"> </span>--no-pager
<span class="c1"># logfiles created by photobooth</span>
cat<span class="w"> </span>~/photobooth-data/log/qbooth.log

<span class="c1"># logfiles created by photobooth every day</span>
ls<span class="w"> </span>~/photobooth-data/log/
cat<span class="w"> </span>~/photobooth-data/log/photobooth_2023xxxx.log

<span class="c1"># check CmaFree especially for Arducams if low:</span>
cat<span class="w"> </span>/proc/meminfo
</code></pre></div>
<p>If service crashed 💀, kill the python process:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># check whether there is a process still running but not responsive:</span>
<h3 id="manually-start-the-app">Manually start the app</h3>
<p>If service crashed 💀, stop the service and maybe even kill the python process:</p>
<div class="highlight"><pre><span></span><code><span class="c1"># stop the photobooth service (if installed)</span>
systemctl<span class="w"> </span>--user<span class="w"> </span>stop<span class="w"> </span>photobooth-app

<span class="c1"># check whether there is a process still running but not responsive:</span>
ps<span class="w"> </span>ax<span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span>python3

<span class="c1"># kill it</span>
sudo<span class="w"> </span>pkill<span class="w"> </span>-9<span class="w"> </span>python3
</code></pre></div>
<p>Manually start the photobooth-app and watch the terminal</p>
<div class="highlight"><pre><span></span><code>photobooth<span class="w"> </span>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>The app uses current directory as data directory! Ensure to <code>cd</code> to the correct directory before starting.</p>
</div>
<div class="highlight"><pre><span></span><code>photobooth
<span class="c1">#or</span>
python<span class="w"> </span>-m<span class="w"> </span>photobooth
</code></pre></div>
<div class="highlight"><pre><span></span><code>INFO: The app uses current directory as data directory!
</code></pre></div>
<p>Watch the terminal for errors and try to debug. If you fail, start a <a href="https://github.com/mgrl/photobooth-app/discussions">discussion</a>.</p>
<h2 id="photobooth-command-not-found">Photobooth command not found</h2>
<p>If there is a warning as following during pip installation and photobooth can't start check the PATH variable</p>
<div class="highlight"><pre><span></span><code>WARNING: The script photobooth is installed in '/home/pi/.local/bin' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
</code></pre></div>
<p>See following is fine, might just need a restart after installation because the path .local/bin did not exist before.</p>
<p>The script <code>photobooth</code> is installed in '/home/pi/.local/bin' which is not on PATH.
Consider adding this directory to PATH.</p>
<p>See following is fine, might just need a restart after installation because the path .local/bin did not exist on newly installed systems.</p>
<div class="highlight"><span class="filename">~/.profile</span><pre><span></span><code><span class="c1"># set PATH so it includes user's private bin if it exists</span>
<span class="k">if</span><span class="w"> </span><span class="o">[</span><span class="w"> </span>-d<span class="w"> </span><span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/.local/bin"</span><span class="w"> </span><span class="o">]</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="k">then</span>
<span class="w"> </span><span class="nv">PATH</span><span class="o">=</span><span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/.local/bin:</span><span class="nv">$PATH</span><span class="s2">"</span>
Expand Down

0 comments on commit dcc0333

Please sign in to comment.