Skip to content

Commit ea11378

Browse files
committed
private plugins readme
1 parent 6258616 commit ea11378

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ jobs:
147147
| `domain` | Custom domain name | _(uses IP)_ | `mautic.example.com` |
148148
| `mautic-version` | Mautic Docker image version | `6.0.5-apache` | `6.0.4-apache` |
149149
| `mautic-port` | Port for Mautic application | `8001` | `8080` |
150-
| `themes` | Custom themes from GitHub/ZIP URLs (comma-separated) | _(none)_ | `https://github.com/user/theme/archive/main.zip` |
151-
| `plugins` | Custom plugins from GitHub/ZIP URLs (comma-separated) | _(none)_ | `https://github.com/user/plugin/archive/main.zip` |
150+
| `themes` | Custom themes from Packagist or GitHub/ZIP URLs | _(none)_ | `vendor/theme:^1.0` or `https://github.com/user/theme/archive/main.zip` |
151+
| `plugins` | Custom plugins from Packagist or GitHub/ZIP URLs | _(none)_ | `vendor/plugin:^2.0` or `https://github.com/user/plugin/archive/main.zip` |
152152
| `mysql-database` | MySQL database name | `mautic` | `mautic_prod` |
153153
| `mysql-user` | MySQL username | `mautic` | `mautic_user` |
154154

@@ -247,6 +247,32 @@ The action will use `composer require` to install these packages into your Mauti
247247
- **GitHub Archives**: `https://github.com/user/repo/archive/refs/heads/main.zip`
248248
- **Tagged Releases**: `https://github.com/user/repo/archive/refs/tags/v1.0.0.zip`
249249
- **Direct ZIP Files**: `https://example.com/plugin.zip`
250+
- **Private Repositories**: `https://token@github.com/user/private-repo/archive/refs/heads/main.zip`
251+
252+
### Accessing Private GitHub Repositories
253+
254+
For private repositories, you can use GitHub Personal Access Tokens in the URL:
255+
256+
```yaml
257+
plugins: |
258+
https://ghp_your_token_here@github.com/yourcompany/private-plugin/archive/refs/heads/main.zip,
259+
https://ghp_another_token@github.com/yourcompany/premium-plugin/archive/refs/tags/v1.0.0.zip
260+
261+
themes: |
262+
https://ghp_your_token_here@github.com/yourcompany/private-theme/archive/refs/heads/main.zip
263+
```
264+
265+
**Setting up GitHub Personal Access Token:**
266+
1. Go to GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
267+
2. Click "Generate new token (classic)"
268+
3. Select scopes: `repo` (for private repositories)
269+
4. Copy the token (starts with `ghp_`)
270+
5. Use format: `https://token@github.com/owner/repo/archive/refs/heads/branch.zip`
271+
272+
**Security Notes:**
273+
- Store tokens in GitHub Secrets, not directly in workflow files
274+
- Use fine-grained tokens with minimal repository access
275+
- Consider using GitHub App installations for organization repositories
250276

251277
**Advantages:**
252278
- ✅ **Faster Startup**: Plugins pre-installed during image build

0 commit comments

Comments
 (0)