mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-13 21:27:40 +02:00
deploy: 1a68b46d0b
This commit is contained in:
github-actions[bot]
@@ -5,7 +5,7 @@
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" name="twitter:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" property="og:url" content="https://docs.opensignlabs.com/docs/self-host/docker/run-locally"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Self-host OpenSign™ with Docker on Linux/MacOS/Windows | OpenSign™"><meta data-rh="true" name="description" content="Steps to run OpenSign™ with docker on Linux/MacOS/Windows:"><meta data-rh="true" property="og:description" content="Steps to run OpenSign™ with docker on Linux/MacOS/Windows:"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/self-host/docker/run-locally"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/self-host/docker/run-locally" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/self-host/docker/run-locally" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Docker","item":"https://docs.opensignlabs.com/docs/category/docker"},{"@type":"ListItem","position":2,"name":"Self-host OpenSign™ with Docker on Linux/MacOS/Windows","item":"https://docs.opensignlabs.com/docs/self-host/docker/run-locally"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenSign™ RSS Feed">
|
||||
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenSign™ Atom Feed"><link rel="stylesheet" href="/assets/css/styles.03fa8acf.css">
|
||||
<script src="/assets/js/runtime~main.626ecddd.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.5671ea78.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.d7d946fe.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
@@ -48,6 +48,9 @@
|
||||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="information-about-env-variables-which-are-used-to-setup-opensign-with-docker-on-localhost">Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost<a href="#information-about-env-variables-which-are-used-to-setup-opensign-with-docker-on-localhost" class="hash-link" aria-label="Direct link to Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost" title="Direct link to Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost" translate="no"></a></h2>
|
||||
<p>To set up OpenSign™ locally using Docker, the following prerequisites are required:</p>
|
||||
<p>Add below Environment Variables to the ".env.prod" file that is automatically created in order to personalize your installation:</p>
|
||||
<blockquote>
|
||||
<p>Beginner note: The .env.prod file is created in the current directory (the same directory where you ran the previous commands). On macOS, files that begin with a dot (.) are hidden by default. To view hidden files in Finder, press Cmd + Shift + . (period), or run ls -a in Terminal. Once you locate the file, you can edit it using any text editor or a command-line editor such as vi or nano.</p>
|
||||
</blockquote>
|
||||
<table><thead><tr><th>Environment Variable</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>PUBLIC_URL</td><td><a href="https://localhost:3001" target="_blank" rel="noopener noreferrer" class="">https://localhost:3001</a> or <a href="https://opensign.yourdomain.com" target="_blank" rel="noopener noreferrer" class="">https://opensign.yourdomain.com</a></td><td>Set it to the URL form where the app home page will be accessed</td></tr><tr><td>MASTER_KEY</td><td>XnAadwKxxByMr</td><td>A 12 character long random secret key that allows access to all the data. It is used in Parse dashboard config to view all the data in the database.</td></tr><tr><td>MONGODB_URI</td><td>mongodb://mongo-container:27017/OpenSignDB</td><td>Mongodb URI to connect to</td></tr><tr><td>PARSE_MOUNT</td><td>/app</td><td>Path on which APIs should be mounted. Do not change this. This variable shall be removed & value hardcoded in the source code in coming versions.</td></tr><tr><td>SERVER_URL</td><td><a href="http://localhost:8080/app" target="_blank" rel="noopener noreferrer" class="">http://localhost:8080/app</a></td><td>Set it to the URL from where APIs will be accessible to the NodeJS functions, for local development it should be localhost:8080/app</td></tr><tr><td>DO_SPACE</td><td>DOSPACENAME</td><td>Digital ocean space name or AWS S3 bucket name for uploading documents</td></tr><tr><td>DO_ENDPOINT</td><td>ams3.digitaloceanspaces.com</td><td>Digital ocean spaces endpoint or AWS S3 endpoint for uploading documents</td></tr><tr><td>DO_BASEURL</td><td><a href="https://dospace.ams3.digitaloceanspaces.com" target="_blank" rel="noopener noreferrer" class="">https://dospace.ams3.digitaloceanspaces.com</a></td><td>Digital ocean baseurl or AWS S3 base URL</td></tr><tr><td>DO_ACCESS_KEY_ID</td><td>YOUR_S3_ACCESS_ID</td><td>Digital ocean spaces access key ID or AWS s3 Access key ID for uploading the docs</td></tr><tr><td>DO_SECRET_ACCESS_KEY</td><td>YOUR_S3_ACCESS_KEY</td><td>Digital ocean spaces secret access key or AWS s3 secret access key for uploading the docs</td></tr><tr><td>DO_REGION</td><td>YOUR_S3_REGION</td><td>Digital ocean spaces region or AWS s3 region</td></tr><tr><td>USE_LOCAL</td><td>true</td><td>If this is set to true, local file storage will be used to save files, and DO credentials will be ignored.</td></tr><tr><td>MAILGUN_API_KEY</td><td>YOUR_MAILGUNAPI_KEY</td><td>Mailgun API Key</td></tr><tr><td>MAILGUN_DOMAIN</td><td>YOUR_MAILGUNAPI_DOMAIN</td><td>Mailgun API Domain</td></tr><tr><td>MAILGUN_SENDER</td><td>-</td><td>Mailgun Sender Mail ID</td></tr><tr><td>SMTP_ENABLE</td><td>false</td><td>If this is set to true, emails will be sent through SMTP, and Mailgun credentials will be ignored.</td></tr><tr><td>SMTP_HOST</td><td>smtp.yourhost.com</td><td>Provide smtp host</td></tr><tr><td>SMTP_PORT</td><td>443</td><td>Provide smtp port number</td></tr><tr><td>SMTP_USERNAME</td><td>-</td><td>Provide username of smtp</td></tr><tr><td>SMTP_USER_EMAIL</td><td><a href="mailto:mailer@yourdomain.com" target="_blank" rel="noopener noreferrer" class="">mailer@yourdomain.com</a></td><td>Provide user email of smtp</td></tr><tr><td>SMTP_PASS</td><td>password</td><td>Provide smtp password</td></tr><tr><td>PFX_BASE64</td><td>-</td><td>Base64 encoded PFX or p12 document signing certificate file. You can generate base64 encoded self sign certificate using the passphrase.</td></tr><tr><td>PASS_PHRASE</td><td>opensign</td><td>Pass phrase of PFX or p12 document signing certificate file.</td></tr><tr><td>APP_ID</td><td>opensign</td><td>(DEPRECATED) This should not be changed if provided; it should be 'opensign'.</td></tr></tbody></table>
|
||||
<h1>Steps to Generate Self Sign Certificate</h1>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"># execute below command and use passphrase 'opensign'</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">openssl genrsa -des3 -out ./local_dev.key 2048</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">openssl req -key ./local_dev.key -new -x509 -days 365 -out ./local_dev.crt</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">openssl pkcs12 -inkey ./local_dev.key -in ./local_dev.crt -export -out ./local_dev.pfx</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">openssl base64 -in ./local_dev.pfx -out ./base64_pfx</span><br></span></code></pre></div></div>
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<meta name="generator" content="Docusaurus v3.9.2">
|
||||
<title data-rh="true">OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" name="twitter:image" content="https://docs.opensignlabs.com/img/docusaurus-social-card.png"><meta data-rh="true" property="og:url" content="https://docs.opensignlabs.com/docs/self-host/docker/upgrade-deployment"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows | OpenSign™"><meta data-rh="true" name="description" content="This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker."><meta data-rh="true" property="og:description" content="This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.opensignlabs.com/docs/self-host/docker/upgrade-deployment"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/self-host/docker/upgrade-deployment" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.opensignlabs.com/docs/self-host/docker/upgrade-deployment" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Docker","item":"https://docs.opensignlabs.com/docs/category/docker"},{"@type":"ListItem","position":2,"name":"OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows","item":"https://docs.opensignlabs.com/docs/self-host/docker/upgrade-deployment"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="OpenSign™ RSS Feed">
|
||||
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="OpenSign™ Atom Feed"><link rel="stylesheet" href="/assets/css/styles.03fa8acf.css">
|
||||
<script src="/assets/js/runtime~main.626ecddd.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.5671ea78.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.d7d946fe.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
||||
Reference in New Issue
Block a user