bostame/workdock-platform
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add github environment setup steps

Browse Source
This commit is contained in:
Md Bayazid Bostame
2026-03-28 23:17:29 +01:00
parent 0c8b4f8040
commit 73fb425357
2 changed files with 121 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
backend/workflows/templates/workflows/developer_handbook.html
View File

@@ -298,6 +298,17 @@ make backup-verify BACKUP_DIR=backups/backup_YYYYmmdd_HHMMSS</code></pre>
</ul>
</li>
</ul>
<h3>Exact GitHub UI steps</h3>
<ol>
<li>Open the private repository on GitHub.</li>
<li>Open <code>Settings</code>.</li>
<li>Open <code>Environments</code> in the left sidebar.</li>
<li>Create the environment <code>development</code>.</li>
<li>Create the environment <code>production</code>.</li>
<li>Open <code>development</code>.</li>
<li>Under <code>Environment secrets</code>, add the deployment secrets one by one.</li>
<li>Repeat later for <code>production</code>.</li>
</ol>
<h3>Current test deployment values</h3>
<ul>
<li>Host: <code>192.168.2.55</code></li>
@@ -305,6 +316,22 @@ make backup-verify BACKUP_DIR=backups/backup_YYYYmmdd_HHMMSS</code></pre>
<li>Path: <code>/opt/workdock</code></li>
<li>URL: <code>http://192.168.2.55:8088</code></li>
</ul>
<h3>Current development secrets</h3>
<ul>
<li><code>TEST_DEPLOY_HOST=192.168.2.55</code></li>
<li><code>TEST_DEPLOY_USER=root</code></li>
<li><code>TEST_DEPLOY_PORT=22</code></li>
<li><code>TEST_DEPLOY_PATH=/opt/workdock</code></li>
<li><code>TEST_DEPLOY_SSH_KEY=&lt;full private key content&gt;</code></li>
</ul>
<h3>First GitHub Actions test</h3>
<ol>
<li>Open GitHub Actions.</li>
<li>Run the workflow <code>Deploy Test</code> on branch <code>develop</code>.</li>
<li>Wait for the SSH upload and deploy steps to finish successfully.</li>
<li>Verify <code>http://192.168.2.55:8088/healthz/</code> returns HTTP 200.</li>
<li>Then verify the app UI in the browser.</li>
</ol>
<div class="note">
The current LAN test deployment intentionally uses <code>DJANGO_DEBUG=1</code> in <code>.env.test</code> because the security checks correctly reject insecure cookie settings when <code>DEBUG=0</code> and the deployment is still plain HTTP. This is acceptable for the internal test box only. Production must run with HTTPS and <code>DEBUG=0</code>.
</div>