added more clarity to instructions
This commit is contained in:
14
README.md
14
README.md
@ -44,18 +44,23 @@ This project includes automated CI/CD pipelines that handle building and deployi
|
||||
|
||||
### Setting up the pipeline
|
||||
|
||||
We will use Gitea (git.medlab.host) as the external repository and GitLab for CI/CD. You will need the following:
|
||||
- A GitLab account
|
||||
- A Gitea repository (Also works with most other Git hosting service)
|
||||
- A Surfer instance along with the access token
|
||||
|
||||
1. **Create GitLab Project**
|
||||
- For external repositories (like git.medlab.host):
|
||||
- Use GitLab's "Run CI/CD for external repo" option
|
||||
- This creates a mirrored GitLab project
|
||||
|
||||
2. **Configure Repository Mirroring** (for external hosting)
|
||||
- Navigate to: `Settings > Repository > Mirror Settings`
|
||||
2. **Configure Gitea Repository Mirroring**
|
||||
- From your Gitea repo go to: `Settings > Repository > Mirror Settings`
|
||||
- Add your GitLab repository URL
|
||||
- Enable push mirroring
|
||||
|
||||
3. **Set Required Variables**
|
||||
- Go to: `Settings > CI/CD > Variables`
|
||||
3. **Set Required Variables on GitLab**
|
||||
- From your GitLab repo go to: `Settings > CI/CD > Variables`
|
||||
- Add these variables:
|
||||
- `SURFER_TOKEN`: Your Surfer access token
|
||||
- Mark as "Masked and hidden"
|
||||
@ -75,6 +80,5 @@ This project includes automated CI/CD pipelines that handle building and deployi
|
||||
- Ensure `.gitlab-ci.yml` exists in your repository root
|
||||
- The pipeline uses `hugomods/hugo:node` for Hugo Extended support
|
||||
- Deployments only trigger on the `publish` branch
|
||||
- Build artifacts are retained for 1 hour
|
||||
|
||||
For more details about Surfer deployment, see: https://docs.cloudron.io/apps/surfer/
|
||||
|
Reference in New Issue
Block a user