Skip to content

Commit ee6cc39

Browse files
baijumclaude
andcommitted
feat: improve portability for forks and self-hosters
Add continue-on-error to platform checkout in validate.yml so forks that can't access towlion/platform don't fail CI. Add deployment secrets table and self-hosting links to README. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent a8e7ebf commit ee6cc39

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

.github/workflows/validate.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ jobs:
1818
with:
1919
repository: towlion/platform
2020
path: _platform
21+
continue-on-error: true
2122

2223
- name: Run spec validator
24+
if: success()
2325
run: python _platform/validator/validate.py --tier 2 --dir .

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,27 @@ docker compose -f deploy/docker-compose.standalone.yml up -d
6666

6767
This includes PostgreSQL, Redis, MinIO, and Caddy alongside your app.
6868

69+
## Deployment Secrets
70+
71+
Configure these GitHub Actions secrets on your repository (**Settings > Secrets and variables > Actions**):
72+
73+
| Secret | Required | Description |
74+
|---|---|---|
75+
| `SERVER_HOST` | Yes | Server IP address |
76+
| `SERVER_USER` | Yes | SSH user (typically `deploy`) |
77+
| `SERVER_SSH_KEY` | Yes | SSH private key for deployment |
78+
| `APP_DOMAIN` | Yes | Application domain (e.g., `app.example.com`) |
79+
| `PREVIEW_DOMAIN` | No | Base domain for PR preview environments (e.g., `example.com`) |
80+
81+
Database and storage credentials are auto-generated on the server by the bootstrap script. They are not GitHub secrets.
82+
83+
## Self-Hosting
84+
85+
For full self-hosting instructions, see the platform documentation:
86+
87+
- [Self-Hosting Guide](https://github.com/towlion/platform/blob/main/docs/self-hosting.md) — Fork model, server requirements, bootstrap process
88+
- [Deployment Tutorial](https://github.com/towlion/platform/blob/main/docs/tutorial.md) — Step-by-step walkthrough from fork to running app
89+
6990
## License
7091

7192
[MIT](LICENSE)

0 commit comments

Comments
 (0)