dawarich icon indicating copy to clipboard operation
dawarich copied to clipboard

Some Clutter Cleanup

Open adromir opened this issue 10 months ago • 7 comments

While Browsing around on the Repository and the WebsiteI realised some clutter, that probably needs some Cleanup

  1. On the Website under Installation it says to use the Docker Compose file, but i couldnt find a link to it. It would be convienient if that would be added on the Website. Maybe this would be a cool feature for the Website: https://github.com/yusanshi/emgithub because you could embed the latest version on your Website and since you can run your own Version via github pages or Webserver you are independent from external availabilty

  2. Under The Watcher Relase I saw that you suggest a change of the compose file to add a gemcache volume to sidekiq but its not added in the provided compose file. If its still necessary, then it should be added to the default compose file and if its obsolete, it should be removed from the website

  3. Since you want to reduce the Load to the komot server, you probably should add the corresponding environment variables to the compose file and encourage people in a comment there to use their own

  4. I am not sure if i remember wrong, because I don't find it, but I think you somewhere mentioned that for Sidekiq Prometheus shouldnt be configured, only for the app (or was it vice versa). If i remember correctly, this should be removed from the compose file as well

adromir avatar Feb 08 '25 09:02 adromir

Two additions from me, as I've deployed Dawarich yesterday:

  • The Docker Compose File in this repository is outdated, as it doesn't contain the following change from the last release:
dawarich_db:
-   image: postgres:14.2-alpine
+   image: postgis/postgis:14-3.5-alpine
    shm_size: 1G
    container_name: dawarich_db
  • Why don't you use a docker .env File as you have repetitive Environment Variables for dawarich_app and dawarich_sidekiq (I might test this on my machine and do a PR)

dabenzel avatar Feb 08 '25 09:02 dabenzel

I think the problem is, that for dawarich app Prometheus needs to be enabled and for the sidekiq it needs to be disabled and since they are both using the same Baseimage just using one env file wouldnt allow that.

Probably it would be better to add a check if the container is started as app or as sidekiq (if even possible, but I think it should be, since both use different entrypoints) and if later disable the exporter alltogether

adromir avatar Feb 08 '25 09:02 adromir

Also, there are two docker-compose files (one with mounts), both have different entrypoint and command for the app (and only the one from docker-compose with mounts works for me)

Dinth avatar Feb 08 '25 10:02 Dinth

On the Website you could add a Tutorial about prometheus. Especially since I found in the release Notes that the Docker compose file needs the Command changed. Or maybe you can add both to the Compose file working with Comments

adromir avatar Feb 08 '25 15:02 adromir

Under The Watcher Relase I saw that you suggest a change of the compose file to add a gemcache volume to sidekiq but its not added in the provided compose file. If its still necessary, then it should be added to the default compose file and if its obsolete, it should be removed from the website

Fixed

Since you want to reduce the Load to the komot server, you probably should add the corresponding environment variables to the compose file and encourage people in a comment there to use their own

They were removed from the compose file to encourage users to do their own research and configure their own hosted instance

I am not sure if i remember wrong, because I don't find it, but I think you somewhere mentioned that for Sidekiq Prometheus shouldnt be configured, only for the app (or was it vice versa). If i remember correctly, this should be removed from the compose file as well

I added a page with information on prometheus monitoring to the docs

The Docker Compose File in this repository is outdated, as it doesn't contain the following change from the last release:

Fixed

Why don't you use a docker .env File as you have repetitive Environment Variables for dawarich_app and dawarich_sidekiq (I might test this on my machine and do a PR)

I prefer having all env vars in one place

Some fixes will be moved to master branch after 0.24.0 release, they are currently in the dev branch

Freika avatar Feb 08 '25 22:02 Freika

Since you want to reduce the Load to the komot server, you probably should add the corresponding environment variables to the compose file and encourage people in a comment there to use their own

They were removed from the compose file to encourage users to do their own research and configure their own hosted instance I love the faith you have in People ;) In my Experience, if Informations are not presented on a golden Plate and fed with a silver spoon, they do exactly nothing

Another thing i just realised: In the Watcher page its mentioned that the FFiles should be put in the Folder

/tmp/imports/watched/[email protected]/

But for me the Subfolder "[email protected]" was never created. So its maybe a bug or the information is outdated

adromir avatar Feb 09 '25 04:02 adromir

@adromir It's not supposed to be created automatically. I'll clarify the docs.

Freika avatar Feb 09 '25 10:02 Freika