QuickChart

QuickChart is a self-hosted chart image service that generates embeddable chart images from URLs for emails, reports, text messages, and dashboards where…

  • Cloud
  • Databases
  • Development
  • Network Services
  • Tools & Utilities
QuickChart is a self-hosted chart image service that generates embeddable chart images from URLs for emails, reports, text messages, and dashboards where dynamic chart rendering is not possible.

Platform availability

Available on 2 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

40/100 Fair

Maintained
0last commit 886 days ago
Popular
662,059 GitHub stars
Easy to install
452 install platforms, install notes, Docker image
Light to run
701 GB minimum RAM
Security check
58no serious findings, 1 minor, tests, OpenSSF Scorecard 1.8/10

Availability: platform listings confirmed today, links checked 53 days ago

GitHub stars
2,059
Open issues
45
Last commit
2024-06-18
Latest release
v1.8.0
License
AGPL-3.0
Activity
stale

Checked 20 days ago - source: GitHub (typpo/quickchart)

Resources & Compatibility

Minimum requirements: 1 GB RAM, 1 CPU core(s), 25 GB disk. ARM (e.g. Raspberry Pi) is not supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Map the web port when using Docker If you use Docker (a self-contained app package), run it with a port mapping like `docker run -p 8080:3400 ianw/quickchart` so your browser can reach QuickChart. The app listens on port 3400 inside the package, and without exposing it the service is hidden and charts won't load. source
  • Check that QuickChart is running Open your QuickChart address plus `/healthcheck` in a browser, for example `http://your-server:8080/healthcheck`. It should return a success message; if it does not, the service did not start properly and charts will fail. source
  • If running from Node.js, know the port Run `node index.js` to start QuickChart when you are not using Docker. It listens on port 3400 by default, so open that port or set PORT if you want it reachable on a different port. source

Fetched 37 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Does QuickChart provide a Docker image for self-hosting?

Yes, QuickChart provides a Docker image for self-hosting.

How should I secure a self-hosted QuickChart instance?

Do not expose the service to untrusted parties. Because Chart.js configs may contain arbitrary JavaScript, the instance must be properly sandboxed.

Can a QuickChart instance render multiple Chart.js versions?

No, each QuickChart instance should use one specific Chart.js version. Mixing and matching versions, such as rendering a v2 chart followed by a v3 chart, is not well supported.

Can QuickChart generate QR codes?

Yes, the /qr endpoint generates QR codes and accepts parameters such as text, format, size, and margin.

Where should I look for chart customization options?

Use the Chart.js documentation and Chart.js-related search terms, because QuickChart is built on the Chart.js library.

Answers sourced from github.com, github.com, quickchart.io, selfhost.directory

Community

Collected 48 days ago - public community threads