{"id":16948791,"url":"https://github.com/dentosal/linux-job-runner","last_synced_at":"2026-05-11T03:36:42.356Z","repository":{"id":49296538,"uuid":"376030417","full_name":"Dentosal/linux-job-runner","owner":"Dentosal","description":"A simple job runner server for Linux hosts","archived":false,"fork":false,"pushed_at":"2021-06-19T12:52:28.000Z","size":59,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-26T06:25:36.467Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dentosal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-11T13:14:25.000Z","updated_at":"2024-07-12T14:48:25.000Z","dependencies_parsed_at":"2022-09-05T14:00:44.831Z","dependency_job_id":null,"html_url":"https://github.com/Dentosal/linux-job-runner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dentosal%2Flinux-job-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dentosal%2Flinux-job-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dentosal%2Flinux-job-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dentosal%2Flinux-job-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dentosal","download_url":"https://codeload.github.com/Dentosal/linux-job-runner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244776273,"owners_count":20508503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T21:52:24.527Z","updated_at":"2026-05-11T03:36:42.314Z","avatar_url":"https://github.com/Dentosal.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Linux job runner\n\nServer and API for running encapsulated Linux commands remotely.\n\n## Code structure\n\n* `common/` code shared by the client and the server, mostly [protobuf](common/proto/common.proto) definitions\n* `server/` server code\n* `client/` client code, and CLI tool\n* `gen-certs.sh`certificate generation code\n* `gen-cert-conf/` certificate configuration\n* `certs/` certificates (generated by gen-certs.sh)\n* `git-hooks.sh` git hook management script\n\n## Dependencies\n\nRequires latest stable Rust release, which can be installed using [rustup](https://rustup.rs/). The project is only tested on Linux systems, and uses platform-specific features (although making them optional might be possible in the future).\n\nA recent version of `openssl` command is required as well.\n\n\n## Setup\n\nFirst generate and export certs with:\n\n```bash\n./gen-certs.sh\nexport TLS_SERVER_ROOT_CA_CRT=certs/ca_server/root-ca.crt\nexport TLS_CLIENT_CRT=certs/client1/client.crt\nexport TLS_CLIENT_KEY=certs/client1/client.key\n```\n\n## Run\n\nUse `cargo run --bin server` to run start the server. By default it starts on `127.0.0.1:8000`, but you can change that by passing in the `host:port`, for instance: `cargo run --bin server 0.0.0.0:8123`.\n\nNow that the server is running, run the client (in another terminal) with `cargo run --bin cli`. For for instance, try:\n\n```bash\nexport SERVER='grpcs://localhost:8000'\n\n# Show the path where out process runs\njob_id=$(cargo run --bin cli $SERVER start pwd)\necho \"Job id: $job_id\"\ncargo run --bin cli $SERVER status $job_id\ncargo run --bin cli $SERVER output $job_id\n\n# Stop a long-running process\njob_id=$(cargo run --bin cli $SERVER start sleep infinity)\necho \"Job id: $job_id\"\ncargo run --bin cli $SERVER status $job_id\ncargo run --bin cli $SERVER stop $job_id\ncargo run --bin cli $SERVER status $job_id\n```\n\n## Client libarary\n\nThe client is also available as a Rust library, under the `client` folder. Documentation for the client can be generated with `cargo doc`, and after that it can be found from `target/doc/client/index.html`. For usage examples look into the [CLI code](client/src/bin/cli.rs), it uses all of the library features.\n\n## Development\n\nCode is formatted with `rustfmt`, use `cargo fmt` to apply.\n\nFor linting `cargo clippy` is used. New changes should not introduce any style regressions.\n\nThe automated test suite can be ran with `cargo test`. This is rather limited at the moment, so manual testing is required.\n\nTo automatically enforce all these in the version control, run `./git-hooks.sh setup`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdentosal%2Flinux-job-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdentosal%2Flinux-job-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdentosal%2Flinux-job-runner/lists"}