Skip to content

Air gap installation requires update (docker compose) #1579

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.

Sign up for GitHub

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

Jump to bottom
Open
AlexBaranowski opened this issue Feb 11, 2025 · 3 comments · May be fixed by #1650
Open

Air gap installation requires update (docker compose) #1579

AlexBaranowski opened this issue Feb 11, 2025 · 3 comments · May be fixed by #1650
Labels
bug Something isn't working

Comments

@AlexBaranowski
Copy link

Current offline installation require update to config files and probably documentation. The following should be fixed:

docker-compose-offline.yml

  web:
    image: scancodeio_web

Exported image is named scancodeio-web

  worker:
    image: scancodeio_worker

Exported image is named scancodeio-worker

Also the starting command should be unified:

The docker-compose.yml vs docker-compose-offline.yml

 worker:
    image: scancodeio_worker
    command: wait-for-it web:8000 -- ./manage.py rqworker --worker-class scancodeio.worker.ScanCodeIOWorker --queue-class scancodeio.worker.ScanCodeIOQueue --verbosity 2

  worker:
    build: .
    # Ensure that potential db migrations run first by waiting until "web" is up
    command: wait-for-it --strict --timeout=120 web:8000 -- sh -c "
        ./manage.py rqworker --worker-class scancodeio.worker.ScanCodeIOWorker
                             --queue-class scancodeio.worker.ScanCodeIOQueue
                             --verbosity 1"

Lastly the clamav configuration is not present (image and volumes)

  clamav:
    image: clamav/clamav
    volumes:
      - clamav_data:/var/lib/clamav
      - workspace:/var/scancodeio/workspace/
    restart: always
(...)
volumes:
  (...)
  clamav_data:
  (...)

With vimdiff the configurations should probably not match only on image: XXX and build: .

Makefile

Makefile should be updated so the docker-images: target would also export the clamav image.

Documentation

Lastly documentation should be revisited to check if it's up to date.

Best,
Alex
@AlexBaranowski AlexBaranowski added the bug Something isn't working label Feb 11, 2025
@AlexBaranowski AlexBaranowski mentioned this issue Feb 11, 2025
Closed
@imfeniljikadara
Copy link

Hey @AlexBaranowski , I'm exited to address this issue, i've already cloned the repository on my system. please assign me this issue, i'm learning how the offline installation is working, also let which specific files should i look into? Thank you!

@AlexBaranowski
Copy link
Author

Ohh, sorry for not writing. I missed the message.

Well, I'm not one who could assign people. I'm not repo owner. You can just fix it and create a PR.

If you still want to work on the issue, you have the general hints in the description.

@imfeniljikadara
Copy link

Hey @AlexBaranowski ,

Thanks for getting back to me! I appreciate the details in the issue description. The fixes seem straightforward:

  • Correcting image names in docker-compose-offline.yml.
  • Unifying the worker command between the two compose files.
  • Adding ClamAV to the offline setup.
  • Ensuring Makefile exports the ClamAV image.
  • Reviewing and updating documentation if needed.

I'll go ahead and start working on these changes and will create a PR once done. Let me know if you have any additional pointers or things I should be aware of.

@imfeniljikadara imfeniljikadara linked a pull request Apr 5, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(docker): Update air gap installation configuration imfeniljikadara/scancode.io
2 participants
@AlexBaranowski @imfeniljikadara