Giter Club home page Giter Club logo

kiri-docker's Introduction

Kiri Docker

Kiri Docker is a convenient and easy way to run Kiri pre-installed in a Ubuntu container.

Kiri repo is not necessary to run Kiri Docker

Kiri Docker works by mounting the user's project from the host machine inside the container. This way, the output files are easily accessible from the host system making it simple to visualize using the host's browser.

The existing kiri-docker image is hosted in Docker Hub here https://hub.docker.com/r/leoheck/kiri/tags

Getting the existing docker image

The docker container can be donwloaded through this repo with:

gh repo clone leoheck/kiri-docker
make docker_pull

Alternatively, you can pull the latest image file with:

docker pull leoheck/kiri:latest

Building your own docker image

It is also possible to build the docker image yourself, if needed:

gh repo clone leoheck/kiri-docker
cd kiri-docker
make docker_build

Environment

Download or build the docker image and then set your PATH to this repo with:

export PATH="$(pwd)/kiri-docker/"

Using Kiri Docker

To run kiri on the given Kicad project repository:

kiri-docker [OPTIONS] [REPO_PATH] [-k|--kiri [ARGS]

For extended arguments list, please use the flag -h.

Examples

Just launch the container for manual exploration

kiri-docker

This example launches kiri-docker, passing the path of the project path and a parameter -r of kiri to remove old files.

kiri-docker "/home/lheck/Documents/assoc-board" -k -r

This, starts the container with the project folder and do nothing, so you can debug something manually.

kiri-docker "/home/lheck/Documents/assoc-board" -d

Launch kiri with a repo that has a nested kicad project (kicad project is not in the root path)

kiri-docker "/home/lheck/Documents/assoc-board" -k "nested_project/board.kicad_pro"

Starts docker binding project's repo, do not run kiri, and run pcbdraw command: This example uses the image generated with Dockerfile_kicad-auto.

kiri-docker "/home/lheck/Documents/assoc-board" -i leoheck/kiri:test -d -c "pcbdraw board.kicad_pcb board.svg"

kiri-docker's People

Contributors

leoheck avatar

Stargazers

avatar avatar avatar avatar avatar avatar

Watchers

avatar

Forkers

usa-reddragon jrhrsmit

kiri-docker's Issues

Problems with the instructions 'How to use kiri-docker'

Hello,
i am not newbie with docker, but i have problems to get kiri running with docker.

I pulled the image from docker hub with

docker pull leoheck/kiri:latest

To access the program inside the container i normally us a command like this inside my project folder.

docker run -it -w /kikit -v $(pwd):/kikit yaqwsx/kikit /bin/bash

Docker mounts the project folder and has access to the files. Then inside the container i run the program.
Can i use Kiri this way?

Why i don't use the described way.
I add export PATH="$(pwd)/kiri-docker/" and get this error.

.autocomplete.async.start:13: command not found: true

I use oh-my-zsh with zsh-autocomplete.plugin.zsh

Running KIRI in Docker Desktop

Some how I don't get KIRI tu run. I downloaded several other images and I can immediately run them with the RUN button in Docker Desktop. The "hello world" images works, as does the ubuntu image via docker desktop.

However I'm not able to run Kiri. I pulled the latest version and have it run directly without any settings modified.
image
Could you give me a hint how I get KIRI to run?

Empty webpage (no diff/file view)

OS: Ubuntu Mate 22.04.2
Browser: Firefox 113.0.1
Kicad: 6.0.2
kiri-docker image: leoheck/kiri latest 2d71b85d6d02

I am trying to perform schematic comparison. For purpose of this demonstration I created dummy project with schematics only, with dummy components. After running
kiri <project absolute path>
I could see the webserver running, but nothing more than general GUI layout (no file selection / preview pane, nothing)
image

Hoping to get some more detail, I looked into the browser Console - and something interesting was there indeed, looking as if kiri-server cannot find / access the files. Listing them from withing docker container is possible though.

When attempting to access via http://172.17.0.2:8080/_local_/ I get simple list of files:
image

Unsurprisingly, when attempting to use URL from the Console there is 404. From picture above already can be seen that there is no _KIRI_ subdirectory and looks that this request is not handled by the server very well.
image

Is that some bug or am I doing something wrong?

Best regards

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.