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

[Feature Request] i would like to be able to run this thing offline #1242

Open
colons opened this issue Feb 21, 2023 · 3 comments
Open

[Feature Request] i would like to be able to run this thing offline #1242

colons opened this issue Feb 21, 2023 · 3 comments

Comments

@colons
Copy link

colons commented Feb 21, 2023

Description

it is very strange to me that this tool for creating keyboard firmware has network dependencies that seem very hard to remove. i spent a few hours trying to get the whole stack running locally, but had very little success

i have some motivations for wanting to do this:

  • i want to be able to edit my keyboard firmware when i don't have internet access
  • i do not trust any of the services in that architecture diagram to be around forever
  • i do not want to have my keyboard layouts stored on other people's computers

i feel like these are all reasonable desires, and kinda fundamental to tinkery open source stuff in general

my ideal version of this would be an entirely self-contained desktop app with a web view that exposes the existing configuration gui without hitting the network at all. after all, if being able to run this thing offline is a desirable thing, then it should be as accessible as possible

if it is already possible to run the stack locally, i would really like there to be documentation that covers how. i would be willing to write it myself, given guidance to understand what's necessary

@fauxpark
Copy link
Member

https://github.com/qmk/qmk_web_stack is probably what you're looking for.

@marschr
Copy link

marschr commented Mar 13, 2023

I just tried running the qmk_web_stack repo and it fails because it seems to have dependencies with a AWS server... urllib3.exceptions.NewConnectionError: <botocore.awsrequest.AWSHTTPConnection object at 0x7f21e505e760>: Failed to establish a new connection: [Errno 111] Connection refused
The configurator architecture page helps a bit to understand how everything is tied together but may I ask if there's any low hanging fruit advice on where to decouple these containers in order to have a locally ran configurator, what is actually needed and for what, so I could load and customize my own JSON keymap files using the WebUI? Also, shouldn't the AWS dependencies be moved to a setting in an env file? Or am I missing something?

@tzarc
Copy link
Member

tzarc commented Mar 13, 2023

The recommendation is to use the docker-compose.yml to start the services -- the storage of files uses MinIO, which is an S3-compatible service. I'd imagine you haven't started it?

I've run through the instructions as per the qmk_web_stack readme, and the services come up fine.

I realise you may wish to bundle things up into your own local desktop app, but realistically, that's the premise of having QMK installed locally and compiling with the CLI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants