Self-host https://assets.cml.dev

[JamesMowatt]

Is it possible to self-host https://assets.cml.dev

I am a little uncomfortable with the idea that this will upload files to a third-party server.

If it isn't something that can be self-hosted I am happy to raise a PR to support GS/S3.

[dmpetrov]

@JamesMowatt CML has no limitations on image hosting. you just need to replace cml-publish command with image uploading code and output the URL to a report. We develop the assets.cml.dev (using S3 and AWS Lambda) just to simplify this process.

You can try to use your own S3 bucket (you will need to set permissions correctly) or some external image hosting services: https://stackoverflow.com/questions/2642570/whats-a-good-image-hosting-site-with-an-api-to-allow-me-upload-images-from-my-w

If you use AWS we can even consider sharing assets.cml.dev source code with you. It can be even open-sourced at some point.

What would be an ideal solution for you?

[tmaier]

Instead of uploading the image somewhere, you may consider to store the image encoded with base64 in the markdown file directly.
See https://superuser.com/questions/1199393/is-it-possible-to-directly-embed-an-image-into-a-markdown-document

[dmpetrov]

@tmaier unfortunately, embedded (base64) images are not supported in GitHub md files: github/markup#270 (comment) This is why we decided to use a unified approach to publishing images.

Does GitLab support base64 images? We can probably implement a special option or a command for GitLab. @DavidGOrtega do you know?

[0x2b3bfa0]

Related:

• Upload and Embed Files to PRs / Issues / Comments cli/cli#1895

[cateseale]

If you use AWS we can even consider sharing assets.cml.dev source code with you. It can be even open-sourced at some point.

@dmpetrov was this opened-sourced in the end? I'd like to be able to use our own (non-public) S3 buckets with cml publish.

[dacbd]

Going to keep this issue until we release some instructions for a way to easier self-host the images, but we have added a URL option to cml publish so with the next release you can export CML_PUBLISH_URL="https://images.mydomain.com/"; cml publish ./plot.png as well as cml publish --url="https://images.mydomain.com/" ./plot.png

[casperdcl]

closing in favour of iterative/cml.dev#266 :)