# Custom Documentation Links

On the yCrash dashboard, when someone opens a REST API upload flow (GC log, thread dump, or heap dump), the modal includes a link to the relevant API documentation. Out of the box those links go to docs.ycrash.io (opens new window).

If you run yCrash Enterprise, you can point those links to your own pages instead - Confluence, an internal wiki, a SharePoint site, or anything your users can open in a browser. You do that with a small JSON file named documentation-links.json.

# Who this applies to

Custom overrides are loaded only in the Enterprise offering. Standard deployments always use the default yCrash documentation URLs, even if a config file is present.

The three overrides map to the REST API documentation links in the dashboard upload experience:

Product API Default documentation URL
GCeasy GC log analysis API https://docs.ycrash.io/ycrash-server/api/gc-log-analysis-api.html
fastThread Thread dump analysis API https://docs.ycrash.io/ycrash-server/api/thread-dump-analysis-api.html
HeapHero Heap dump analysis API https://docs.ycrash.io/ycrash-server/api/heap-dump-analysis-api.html

Scope today: Custom documentation links apply only to these three URLs - the REST API doc links in the upload modals above. Other links elsewhere in the product are not configurable through documentation-links.json.

# Configuration file

Create documentation-links.json and make it available using one of the locations below (the server checks them in this order):

  1. System property - -Ddocumentation.links.file=/absolute/path/to/documentation-links.json
    Useful when you want an explicit path outside the upload directory.

  2. Upload directory - {upload directory}/documentation-links.json
    Place this file in your yCrash application's Upload Directory (opens new window).

# JSON format

Keys are fixed identifiers. Each key maps to the URL you want users to open:

Key What it overrides
gc-api-docs GC log analysis API doc link
heap-api-docs Heap dump analysis API doc link
thread-api-docs Thread dump analysis API doc link

You can set one, two, or all three. Any key you omit keeps the default yCrash URL.

{
  "gc-api-docs": "https://wiki.your-company.com/gc-api",
  "heap-api-docs": "https://wiki.your-company.com/heap-api",
  "thread-api-docs": "https://wiki.your-company.com/thread-api"
}
1
2
3
4
5

Partial example (only GC and thread):

{
  "gc-api-docs": "https://wiki.your-company.com/gc-guide",
  "thread-api-docs": "https://wiki.your-company.com/thread-guide"
}
1
2
3
4

After changing the file, restart the application so cached settings pick up the new changes.

Note:

This feature is available from version 3.2 and later

← My Patterns →