Setup Guide
This guide walks you through creating an Alfresco account and obtaining the Basic Authentication credentials required to use the Alfresco connector.
Prerequisites
- An active Alfresco Content Services instance. If you do not have one, sign up for a free trial.
Step 1: Set up your Alfresco environment
- Go to Alfresco's trial page and register for an account.
- Once registered, follow the instructions in the setup email to provision your Alfresco Content Services instance.
If you are using a self-hosted Alfresco deployment, ensure that the Alfresco REST API is enabled and accessible.
Step 2: Obtain your credentials
- Note the default username and password provided in the setup email or configured during installation.
- For self-hosted deployments, the default admin credentials are typically
admin/admin— change these immediately in production. - These credentials are used for Basic Authentication with the connector.
Store your credentials securely. Do not commit them to source control. Use Ballerina's configurable feature and a Config.toml file to supply them at runtime.
Step 3: Get your service URL
The service URL is the base URL of your Alfresco Content Services REST API:
https://<your-alfresco-host>/alfresco/api/-default-/public/alfresco/versions/1
For Alfresco Cloud (Hyland Experience Platform), the URL is provided in your setup instructions. For local or self-hosted deployments, replace <your-alfresco-host> with your server's hostname and port (for example, http://localhost:8080).
Verify the service URL by opening <serviceUrl>/nodes/-root- in a browser and authenticating with your credentials. A successful response confirms the URL is correct.
What's next
- Action reference: Available operations