Custom URL for diagram generation - PlantUML for Confluence

Our PlantUML for Confluence app allows you to create and manage diagrams efficiently. To enhance your experience, you can set up a custom URL for diagram generation. This feature is particularly useful if you prefer using a private server for generating diagrams.

To setup a private server, checkout this page: https://appsfoundry.atlassian.net/wiki/spaces/PLANTUML/pages/478085126

Accessing the Settings

To configure the Custom URL:

  1. Go to Confluence Administration.

  2. Select PlantUML for Confluence from the menu.

Configuring the Custom URL

In the PlantUML for Confluence settings, you will find the option to specify a custom URL. This URL will direct the app to use your chosen server for generating diagrams.

Steps:

  1. Find the Custom URL Field: Look for a field or option labeled "Custom URL" or similar.

  2. Enter the Custom URL:

    • For PNG diagrams, use the format: https://domain.to.server.com/plantuml/png/

    • For SVG diagrams, use the format: https://domain.to.server.com/plantuml/svg/

    Replace domain.to.server.com with your server's actual domain.

    Remember, not all diagrams are compatible with SVG format. For instance, ditaa diagrams can only be generated as PNG files.

  3. Save Your Changes: After entering the URL, make sure to save your settings.

Important Considerations

  • URL Format: The URL should start with https:// and end with a /.

  • Server Accessibility: Ensure your server is externally accessible and secured with HTTPS.

  • Fallback to Default: If no custom URL is entered, or if there's an issue with the entered URL, the app will default to https://www.plantuml.com/plantuml/svg/.

Troubleshooting

  • Invalid URL: If you encounter an error stating the URL is invalid, check to ensure it starts with https://, includes /plantuml/ in the path, and ends with a /.

  • Error Messages: Pay attention to any error messages you receive. They are designed to be clear and will guide you in correcting common issues.

  • Empty URL: An empty URL field will automatically default to the standard PlantUML server.

 

Disclaimer

Please note that while configuring a custom URL allows for greater flexibility and control, we are not responsible for any misuse or vulnerabilities that may arise from using a custom server.