-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathindex.html
More file actions
261 lines (238 loc) · 14.4 KB
/
index.html
File metadata and controls
261 lines (238 loc) · 14.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="Photobooth Project documentation" /><meta name="author" content="Photobooth Team" /><link rel="canonical" href="https://photoboothproject.github.io/" />
<link rel="shortcut icon" href="img/favicon.ico" />
<title>Photobooth Project</title>
<link rel="stylesheet" href="css/theme.css" />
<link rel="stylesheet" href="css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
<link href="assets/css/extra.css" rel="stylesheet" />
<script>
// Current page data
var mkdocs_page_name = "Home";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = "/";
</script>
<!--[if lt IE 9]>
<script src="js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/yaml.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/rust.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> Photobooth Project
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="#">Home</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#start-here">Start here</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#what-photobooth-is-and-is-not">What Photobooth is (and is not)</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#project-background">Project background</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#news-and-releases">News and releases</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#contribute-to-this-documentation">Contribute to this documentation</a>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="news/">News & Releases</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install & Setup</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install/">Overview</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/prerequisites/">Prerequisites</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/supported_platformscand_cameras/">Supported Platforms and Cameras</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/setup_wizard/">Photobooth Setup Wizard</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/install-debian/">Install on Debian</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/install-nginx/">Enable PHP in nginx</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="install/install-windows/">Install on Windows</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Upgrade & Maintenance</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="update/">Overview</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="update/update-linux/">Update on Linux</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog/">Changelog</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="security/">Security Policy</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Troubleshooting & Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="faq/">FAQ</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/preview/">Preview and live background</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/pi-camera/">Pi Camera setup</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/custom-collage/">Custom collage design</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/kiosk-mode/">Kiosk mode</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/hide-cursor/">Hide cursor & screen blanking</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/screensaver/">Screensaver</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/tutorials/">Tutorials</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/remote-button/">Remote Buttons</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/usb-sync/">USB Sync & Move2USB</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/printer-troubleshooting/">Printer Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/gphoto2-troubleshooting/">gphoto2 Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="faq/go2rtc-troubleshooting/">GO2RTC Troubleshooting</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Customize & Extend</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="customizing/">Overview</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="customizing/sounds/">Sounds</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="customizing/themes/">Themes</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="customizing/styles/">CSS styles</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="scripts/">Scripts</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Community</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://t.me/PhotoboothGroup">Chat on Telegram</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="code_of_conduct/">Contributor Covenant Code of Conduct</a>
</li>
<li class="toctree-l1"><a class="" href="https://crowdin.com/project/photobooth">Translate Photobooth</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing/">Contribute to Photobooth</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing-docs/">Contribute to the docs</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="donation/">Donation</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">Photobooth Project</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item active">Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/PhotoboothProject/photobooth/blob/dev/docs/index.md" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p><em>Latest development version:</em>
<a href="https://github.com/PhotoboothProject/photobooth/actions/workflows/lint.yaml"><img alt="Lint" src="https://github.com/PhotoboothProject/photobooth/actions/workflows/linters.yaml/badge.svg" /></a>
<a href="https://github.com/PhotoboothProject/photobooth/actions/workflows/gulp_sass.yml"><img alt="gulp-sass" src="https://github.com/PhotoboothProject/photobooth/actions/workflows/gulp_sass.yml/badge.svg" /></a>
<a href="https://github.com/PhotoboothProject/photobooth/actions/workflows/build.yml"><img alt="Build" src="https://github.com/PhotoboothProject/photobooth/actions/workflows/build.yml/badge.svg" /></a></p>
<p><img alt="" src="https://raw.githubusercontent.com/PhotoboothProject/photobooth/dev/resources/img/logo/banner.png" /></p>
<h1 id="photobooth">Photobooth</h1>
<p>Photobooth turns a connected camera and screen into an offline-friendly photo booth for events on Linux and Windows. It runs on your own hardware (Pi, PC, mini‑PC) and ships features like countdowns, live preview, photo/collage workflows, filters, printing and a gallery.</p>
<h2 id="start-here">Start here</h2>
<ul>
<li>Install & setup: begin with the <a href="install/prerequisites/">prerequisites</a> and pick an <a href="install/">install guide</a> for your platform.</li>
<li>Upgrade: follow the <a href="update/update-linux/">update guide for Linux</a> and check the <a href="changelog/">changelog</a> for release details.</li>
<li>Customize: tweak sounds, themes and styles in <a href="customizing/">Customizing</a>.</li>
<li>Troubleshoot: find answers in the <a href="faq/">FAQ</a> and <a href="faq/tutorials/">tutorials</a>.</li>
<li>Community: join the <a href="https://t.me/PhotoboothGroup">Telegram chat</a> or read the <a href="code_of_conduct/">code of conduct</a>.</li>
</ul>
<h2 id="what-photobooth-is-and-is-not">What Photobooth is (and is not)</h2>
<ul>
<li>Self-hosted event software that stays local after setup and does not require cloud services or accounts.</li>
<li>Not a hosted website where guests upload from home, nor a permanent online gallery or full image editor.</li>
<li>Requires a supported OS and basic configuration; it is not a one‑click kiosk appliance.</li>
</ul>
<h2 id="project-background">Project background</h2>
<p>Photobooth was initially developed by Andre Rinas (<a href="https://github.com/andreknieriem/photobooth">original source</a>). In 2019 Andreas Skomski continued the work and, together with the community, grew Photobooth into the feature-rich project you see today.</p>
<h2 id="news-and-releases">News and releases</h2>
<p>Catch up on recent announcements, release highlights and community updates in the <a href="news/">News</a>. Full version details are listed in the <a href="changelog/">Changelog</a>.</p>
<p>Overall the code got optimized and cleaned up. There's also a lot of new options added.</p>
<p>Photobooth is now again compatible with Windows, also PHP8 won't cause trouble.</p>
<p>If you find a bug you're welcome to report it on the <a href="https://github.com/PhotoboothProject/photobooth/issues">GitHub issue page</a>.</p>
<p><a href="update/">Update instructions</a> have been updated, you can now easily update your existing git installation of Photobooth using the photobooth installer!</p>
<p>Enjoy Photobooth v4!</p>
<h2 id="contribute-to-this-documentation">Contribute to this documentation</h2>
<p>See the <a href="contributing-docs/">contribution guide</a> for setup, editing tips and how to run the docs locally before opening a PR.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="news/" class="btn btn-neutral float-right" title="News & Releases">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/PhotoboothProject/photobooth" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="news/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script src="js/jquery-3.6.0.min.js"></script>
<script>var base_url = ".";</script>
<script src="js/theme_extra.js"></script>
<script src="js/theme.js"></script>
<script src="search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
<!--
MkDocs version : 1.6.1
Build Date UTC : 2026-04-08 04:28:32.089815+00:00
-->