Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API? #14

Closed
NoLooseEnds opened this issue Jun 9, 2021 · 7 comments · Fixed by #72
Closed

API? #14

NoLooseEnds opened this issue Jun 9, 2021 · 7 comments · Fixed by #72
Labels
🔨 Feature New feature or request 👋 Help Wanted Extra attention is needed

Comments

@NoLooseEnds
Copy link

Would it be possible with some sort of API, that you can add labels to your docker-compose files and automatically populate Flames dashboard?

@pawelmalak
Copy link
Owner

Hi. As I said before this is my first time using Docker in any project so I don't know if it would be possible to implement. Do you know any other project that implements that kind of functionality so I could take a closer look at it?

Right now, flame exposes RESTful API for apps, categories and bookmarks if that's what you mean.

@pawelmalak pawelmalak added the question Further information is requested label Jun 9, 2021
@NoLooseEnds
Copy link
Author

Traefik maybe? I think you need to expose the docker.socket, but I'm no developer, so not sure.

@pawelmalak
Copy link
Owner

Sorry, but for now implementation of this feature is out of my skill and knowlage range.

@NoLooseEnds
Copy link
Author

NoLooseEnds commented Jun 9, 2021

I suggest that you leave it open, so that other devs maybe can help if they see it and it's something they know how to do.
Mark it with help wanted for instance and maybe add it to a milestone if it's a feature you like. :)

Like this:
Screenshot 2021-06-09 at 22 58 19

@pawelmalak pawelmalak reopened this Jun 9, 2021
@pawelmalak pawelmalak added 🔨 Feature New feature or request 👋 Help Wanted Extra attention is needed and removed question Further information is requested labels Jun 9, 2021
@rgriffogoes
Copy link
Contributor

I'm in a search for such feature, but I guess the popular dashboards options also don't have it. Currently I'm investigating what would be the best option, and I guess Flame seems to be a good candidate (API already there).

And instead of trying to consume docker api (like Portainer and Traefik does), I was even thinking about consuming Traefik api (rawdata) -- that way it would be possible to generate apps even for non-docker things, and the whole "url/pathprefix" problem would be already solved.

So the problem is divided in different parts, and a final solution could be a mix of any:

Data acquisition:

  1. Read docker socket for special labels
  2. Consume Traefik api

Feature placement:

  1. Simple script to be called/croned
  2. Independent simple app (with timed checks, listener on socket, webapi to be hooked)
  3. Feature in Dashboard code

Target Dashboard:

  1. Flame (rest api)
  2. Homer (static file generation)
  3. Heimdall (no idea)
  4. Organizr (no idea)

I've been using Organizr for a few years already, but the other dashboards I installed just recently.

@jjack
Copy link

jjack commented Jul 16, 2021

Would it be possible with some sort of API, that you can add labels to your docker-compose files and automatically populate Flames dashboard?

I'm not sure how much Flame would be able to automatically populate with just labels and nothing else exposed/consumable.

If you were to label a container as being flammable, Flame would then need some way of determining the type, category, name, url, and icon for it. Many of those would be awfully hard (if not impossible) to divine on their own, so you'd also need to use labels to define the values.

eg:

labels:
  - flame.type=application
  - flame.category=downloads
  - flame.name=Downloader 3000
  - flame.url=http://localhost:3000
  - flame.icon=icon-name

And at that point, you're pretty much just making a distributed configuration file for Flame.

@NoLooseEnds
Copy link
Author

Dunno. Maybe you need to connect to the docker socket?

The point is to get Flame dynamicly show the active services, so being able to set them that way would be awesome.

@pawelmalak pawelmalak linked a pull request Aug 5, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 Feature New feature or request 👋 Help Wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants