Mirrors/Claper
1
0
Fork 0
mirror of https://github.com/ClaperCo/Claper.git synced 2026-02-24 04:01:04 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Claper/configuration.html

200 lines
14 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html 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="generator" content="ExDoc v0.29.4">
<meta name="project" content="Claper v1.7.0">
<title>Configuration — Claper v1.7.0</title>
<link rel="stylesheet" href="dist/html-elixir-HHVY3JYD.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
<script src="dist/sidebar_items-E6912480.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JDI3AVDD.js"></script>
</head>
<body data-type="extras" class="page-extra">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="https://claper.co">
<img src="assets/logo.png" alt="Claper" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="https://claper.co" class="sidebar-projectName" translate="no">
Claper
</a>
<div class="sidebar-projectVersion" translate="no">
v1.7.0
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">GUIDES</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/ClaperCo/Claper/blob/main/guides/introduction/configuration.md#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span>Configuration</span>
</h1>
<h2 id="environment-file" class="section-heading">
<a href="#environment-file" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">environment-file</p>
</a>
Environment file
</h2>
<p>All configuration used by the app is stored in the <code class="inline">.env</code> file. You can find an example file in <code class="inline">.env.sample</code>, but you should copy it to <code class="inline">.env</code> and fill it with your own values (described below).</p><h3 id="storage" class="section-heading">
<a href="#storage" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">storage</p>
</a>
Storage
</h3>
<table><thead><tr><th style="text-align: left;">Variable</th><th style="text-align: left;">Values</th><th style="text-align: left;">Default</th><th style="text-align: left;">Required</th><th style="text-align: left;">Description</th></tr></thead><tbody><tr><td style="text-align: left;">PRESENTATION_STORAGE</td><td style="text-align: left;">local, s3</td><td style="text-align: left;">local</td><td style="text-align: left;">-</td><td style="text-align: left;">Define where the presentation files will be stored</td></tr><tr><td style="text-align: left;">PRESENTATION_STORAGE_DIR</td><td style="text-align: left;">-</td><td style="text-align: left;">priv/static (/app/uploads for Docker)</td><td style="text-align: left;">-</td><td style="text-align: left;">If <code class="inline">local</code> storage is used, this is the directory where the presentation files will be stored. Compile-time config, so you need to recompile the app if you change it (or rebuild the Docker image).</td></tr><tr><td style="text-align: left;">AWS_ACCESS_KEY_ID</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for s3</em></td><td style="text-align: left;">Your AWS Access Key ID</td></tr><tr><td style="text-align: left;">AWS_SECRET_ACCESS_KEY</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for s3</em></td><td style="text-align: left;">Your AWS Secret Access Key</td></tr><tr><td style="text-align: left;">AWS_PRES_BUCKET</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for s3</em></td><td style="text-align: left;">The name of the bucket where the presentation files will be stored</td></tr><tr><td style="text-align: left;">AWS_REGION</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for s3</em></td><td style="text-align: left;">The region where the bucket is located</td></tr></tbody></table><h3 id="mail" class="section-heading">
<a href="#mail" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">mail</p>
</a>
Mail
</h3>
<table><thead><tr><th style="text-align: left;">Variable</th><th style="text-align: left;">Values</th><th style="text-align: left;">Default</th><th style="text-align: left;">Required</th><th style="text-align: left;">Description</th></tr></thead><tbody><tr><td style="text-align: left;">MAIL_TRANSPORT</td><td style="text-align: left;">local, smtp, postmark</td><td style="text-align: left;">local</td><td style="text-align: left;">-</td><td style="text-align: left;">Define how the emails will be sent</td></tr><tr><td style="text-align: left;">MAIL_FROM</td><td style="text-align: left;">-</td><td style="text-align: left;">Claper</td><td style="text-align: left;">-</td><td style="text-align: left;">Email address used to send emails</td></tr><tr><td style="text-align: left;">MAIL_FROM_NAME</td><td style="text-align: left;">-</td><td style="text-align: left;">noreply@claper.co</td><td style="text-align: left;">-</td><td style="text-align: left;">Name used to send emails</td></tr><tr><td style="text-align: left;">SMTP_RELAY</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for smtp</em></td><td style="text-align: left;">SMTP relay server</td></tr><tr><td style="text-align: left;">SMTP_USERNAME</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for smtp</em></td><td style="text-align: left;">SMTP username</td></tr><tr><td style="text-align: left;">SMTP_PASSWORD</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for smtp</em></td><td style="text-align: left;">SMTP password</td></tr><tr><td style="text-align: left;">SMTP_PORT</td><td style="text-align: left;">-</td><td style="text-align: left;">25</td><td style="text-align: left;">-</td><td style="text-align: left;">SMTP port</td></tr><tr><td style="text-align: left;">SMTP_TLS</td><td style="text-align: left;">always, never, if_available</td><td style="text-align: left;">always</td><td style="text-align: left;">-</td><td style="text-align: left;">SMTP TLS</td></tr><tr><td style="text-align: left;">SMTP_AUTH</td><td style="text-align: left;">always, never, if_available</td><td style="text-align: left;">always</td><td style="text-align: left;">-</td><td style="text-align: left;">SMTP Auth</td></tr><tr><td style="text-align: left;">SMTP_SSL</td><td style="text-align: left;">true, false</td><td style="text-align: left;">true</td><td style="text-align: left;">-</td><td style="text-align: left;">SMTP SSL</td></tr><tr><td style="text-align: left;">ENABLE_MAILBOX_ROUTE</td><td style="text-align: left;">true, false</td><td style="text-align: left;">false</td><td style="text-align: left;">-</td><td style="text-align: left;">Enable/disable route to local mailbox (<code class="inline">/dev/mailbox</code>)</td></tr><tr><td style="text-align: left;">MAILBOX_USER</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;">Basic auth user for mailbox route</td></tr><tr><td style="text-align: left;">MAILBOX_PASSWORD</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;">Basic auth password for mailbox route</td></tr><tr><td style="text-align: left;">POSTMARK_API_KEY</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;"><em>only for postmark</em></td><td style="text-align: left;">Postmark API key</td></tr></tbody></table><h3 id="application" class="section-heading">
<a href="#application" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">application</p>
</a>
Application
</h3>
<table><thead><tr><th style="text-align: left;">Variable</th><th style="text-align: left;">Values</th><th style="text-align: left;">Default</th><th style="text-align: left;">Required</th><th style="text-align: left;">Description</th></tr></thead><tbody><tr><td style="text-align: left;">ENABLE_ACCOUNT_CREATION</td><td style="text-align: left;">true, false</td><td style="text-align: left;">true</td><td style="text-align: left;">-</td><td style="text-align: left;">Enable/disable user registration</td></tr><tr><td style="text-align: left;">MAX_FILE_SIZE_MB</td><td style="text-align: left;">-</td><td style="text-align: left;">15</td><td style="text-align: left;">-</td><td style="text-align: left;">Max file size to upload in MB</td></tr><tr><td style="text-align: left;">GS_JPG_RESOLUTION</td><td style="text-align: left;">-</td><td style="text-align: left;">300x300</td><td style="text-align: left;">-</td><td style="text-align: left;">Resolution (DPI) of the JPG generated from PDF, higher resolution means bigger files but better quality</td></tr></tbody></table><h2 id="production-docker" class="section-heading">
<a href="#production-docker" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i>
<p class="sr-only">production-docker</p>
</a>
Production / Docker
</h2>
<p>You can use all local variables plus the following:</p><table><thead><tr><th style="text-align: left;">Variable</th><th style="text-align: left;">Values</th><th style="text-align: left;">Default</th><th style="text-align: left;">Required</th><th style="text-align: left;">Description</th></tr></thead><tbody><tr><td style="text-align: left;">DATABASE_URL</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;">✓</td><td style="text-align: left;">Postgres connection string</td></tr><tr><td style="text-align: left;">SECRET_KEY_BASE</td><td style="text-align: left;">-</td><td style="text-align: left;">-</td><td style="text-align: left;">✓</td><td style="text-align: left;">Generate it with <a href="https://hexdocs.pm/phoenix/1.7.2/Mix.Tasks.Phx.Gen.Secret.html"><code class="inline">mix phx.gen.secret</code></a></td></tr><tr><td style="text-align: left;">ENDPOINT_HOST</td><td style="text-align: left;">-</td><td style="text-align: left;">localhost</td><td style="text-align: left;">-</td><td style="text-align: left;">Host used to access the app (used for url generation)</td></tr><tr><td style="text-align: left;">ENDPOINT_PORT</td><td style="text-align: left;">-</td><td style="text-align: left;">80</td><td style="text-align: left;">-</td><td style="text-align: left;">Port used to access the app (used for url generation)</td></tr><tr><td style="text-align: left;">PORT</td><td style="text-align: left;">-</td><td style="text-align: left;">4000</td><td style="text-align: left;">-</td><td style="text-align: left;">Port to listen to</td></tr></tbody></table>
<div class="bottom-actions">
<div class="bottom-actions-item">
<a href="overview.html" class="bottom-actions-button" rel="prev">
<span class="subheader">
← Previous Page
</span>
<span class="title">
Overview
</span>
</a>
</div>
<div class="bottom-actions-item">
<a href="installation.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
Local installation
</span>
</a>
</div>
</div>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Claper.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.29.4) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink