Skip to content

Commit 3fb49b6

Browse files
committed
feature: documentation updates
1 parent 0247f4e commit 3fb49b6

1 file changed

Lines changed: 36 additions & 2 deletions

File tree

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,9 @@ leading to better products and faster delivery times.
7777
- macos-14 (arm64)
7878
- Ubuntu-22.04
7979

80-
Note: Currently, plugins are only compatible to use with **Appcircle Cloud**.
81-
**Self-hosted** support will be available in future releases.
80+
Note: Both **Appcircle Cloud** and **self-hosted** Appcircle installations are
81+
supported. See [Self-Hosted Appcircle](#self-hosted-appcircle) below to configure
82+
custom endpoints.
8283

8384
### Testing Distribution
8485

@@ -127,6 +128,39 @@ Local Action' with the appropriate information.
127128
- `message`: Your message to testers, ensuring they receive important updates
128129
and information regarding the application.
129130

131+
### Self-Hosted Appcircle
132+
133+
If you run a self-hosted Appcircle installation, point the action to your own
134+
servers with the optional `authEndpoint` and `apiEndpoint` inputs. When omitted,
135+
they default to the Appcircle cloud (`https://auth.appcircle.io` and
136+
`https://api.appcircle.io`), so existing cloud workflows keep working without any
137+
change.
138+
139+
```yaml
140+
- name: Publish App to Appcircle
141+
uses: appcircleio/appcircle-testing-distribution-githubaction
142+
with:
143+
personalAPIToken: ${{ secrets.AC_PROFLE_API_TOKEN }}
144+
profileName: ${{ secrets.AC_PROFILE_NAME }}
145+
createProfileIfNotExists: ${{ secrets.CREATE_PROFILE_IF_NOT_EXISTS }}
146+
appPath: ${{ secrets.APP_PATH }}
147+
message: ${{ secrets.MESSAGE }}
148+
authEndpoint: https://auth.your-appcircle-domain.com
149+
apiEndpoint: https://api.your-appcircle-domain.com
150+
```
151+
152+
- `authEndpoint`: Base URL of the self-hosted Appcircle authentication server.
153+
Optional; defaults to `https://auth.appcircle.io`.
154+
- `apiEndpoint`: Base URL of the self-hosted Appcircle API server. Optional;
155+
defaults to `https://api.appcircle.io`.
156+
157+
> **Self-signed or private CA certificates:** If your self-hosted Appcircle server
158+
> uses a self-signed certificate (or one issued by a private/internal CA), requests
159+
> will fail certificate validation. The action does not disable TLS verification.
160+
> Trust the server's CA on the runner — set the `NODE_EXTRA_CA_CERTS` environment
161+
> variable to a PEM file containing the CA certificate, or add the CA to the system
162+
> certificate store.
163+
130164
### Leveraging Environment Variables
131165

132166
Utilize environment variables seamlessly by substituting the parameters with

0 commit comments

Comments
 (0)