{"id":23708561,"url":"https://github.com/decryptus/auton","last_synced_at":"2025-09-03T14:32:58.048Z","repository":{"id":57412872,"uuid":"161066355","full_name":"decryptus/auton","owner":"decryptus","description":"Execute programs and command-lines on remote servers through HTTP","archived":false,"fork":false,"pushed_at":"2023-01-20T14:46:42.000Z","size":141,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-17T02:55:36.544Z","etag":null,"topics":["cli","command-line","docker","http","http-proxy","proxy","runner"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/decryptus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-09T17:57:33.000Z","updated_at":"2022-01-07T10:35:35.000Z","dependencies_parsed_at":"2023-02-12T03:00:50.929Z","dependency_job_id":null,"html_url":"https://github.com/decryptus/auton","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fauton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fauton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fauton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decryptus%2Fauton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decryptus","download_url":"https://codeload.github.com/decryptus/auton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231895815,"owners_count":18442361,"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":["cli","command-line","docker","http","http-proxy","proxy","runner"],"created_at":"2024-12-30T18:01:08.619Z","updated_at":"2024-12-30T18:01:13.124Z","avatar_url":"https://github.com/decryptus.png","language":"Python","readme":"## auton project\n\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/auton.svg)](https://pypi.org/project/auton/)\n[![PyPI version shields.io](https://img.shields.io/pypi/v/auton.svg)](https://pypi.org/project/auton/)\n[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/decryptus/auton)](https://hub.docker.com/r/decryptus/auton)\n[![Documentation Status](https://readthedocs.org/projects/auton/badge/?version=latest)](https://auton.readthedocs.io/)\n\nauton is a free and open-source, we develop it to run programs and command-lines on remote servers through HTTP protocol.\nThere are two programs, auton for client side and autond for server side.\nauton is just a helper to transform command-lines into HTTP protocol, it is able to transform basic arguments, file arguments and environment variables.\nFor example, you can use auton from CI/CD to run on remote servers, you just need to configure your endpoints:\n  - [ansible](https://github.com/ansible/ansible)\n  - [curl](https://github.com/curl/curl)\n  - [terraform](https://github.com/hashicorp/terraform)\n\nYou can also use auton if you need to execute a new version of a software but you can't install it on a legacy server\nor tests programs execution.\n\n## Quickstart\n\nUsing autond in Docker\n\n`docker-compose up -d`\n\nSee [docker-compose.yml](docker-compose.yml)\n\n## Installation\n\n### autond for server side\n\n`pip install autond`\n\n### auton for client side\n\n`pip install auton`\n\n## Environment variables\n\n### autond\n\n| Variable         | Description                 | Default |\n|:-----------------|:----------------------------|:--------|\n| `AUTOND_CONFIG`  | Configuration file contents\u003cbr /\u003e(e.g. `export AUTOND_CONFIG=\"$(cat auton.yml)\"`) |  |\n| `AUTOND_LOGFILE` | Log file path               | /var/log/autond/daemon.log |\n| `AUTOND_PIDFILE` | autond pid file path        | /run/auton/autond.pid |\n| `AUTON_GROUP`    | auton group                 | auton or root |\n| `AUTON_USER`     | auton user                  | auton or root |\n\n### auton\n\n| Variable               | Description                 | Default |\n|:-----------------------|:----------------------------|:--------|\n| `AUTON_AUTH_USER`      | user for authentication     | \u003cspan/\u003e |\n| `AUTON_AUTH_PASSWD`    | password for authentication | \u003cspan/\u003e |\n| `AUTON_ENDPOINT`       | name of endpoint            | \u003cspan/\u003e |\n| `AUTON_LOGFILE`        | Log file path               | /var/log/auton/auton.log |\n| `AUTON_NO_RETURN_CODE` | Do not exit with return code if present | False |\n| `AUTON_UID`            | auton job uid               | random uuid |\n| `AUTON_URI`            | autond URI(s)\u003cbr /\u003e(e.g. http://auton-01.example.org:8666,http://auton-02.example.org:8666) | \u003cspan/\u003e |\n\n## Autond configuration\n\nSee configuration example [etc/auton/auton.yml.example](etc/auton/auton.yml.example)\n\n### Endpoints\n\nIn this example, we declared three endpoints: ansible-playbook-ssh, ansible-playbook-http, curl.\nThey used subproc plugin.\n\n```yaml\nendpoints:\n  ansible-playbook-ssh:\n    plugin: subproc\n    config:\n      prog: ansible-playbook\n      timeout: 3600\n      args:\n        - '/etc/ansible/playbooks/ssh-install.yml'\n        - '--tags'\n        - 'sshd'\n      become:\n        enabled: true\n      env:\n        DISPLAY_SKIPPED_HOSTS: 'false'\n  ansible-playbook-http:\n    plugin: subproc\n    config:\n      prog: ansible-playbook\n      timeout: 3600\n      args:\n        - '/etc/ansible/playbooks/http-install.yml'\n        - '--tags'\n        - 'httpd'\n      become:\n        enabled: true\n      env:\n        DISPLAY_SKIPPED_HOSTS: 'false'\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      timeout: 3600\n```\n\n### Authentication\n\nTo enable authentication, you must add `auth_basic` and `auth_basic_file` lines in section `general`:\n\n```yaml\n  auth_basic:      'Restricted'\n  auth_basic_file: '/etc/auton/auton.passwd'\n```\n\nUse `htpasswd` to generate `auth_basic_file`:\n\n`htpasswd -c -s /etc/auton/auton.passwd foo`\n\nAnd you have to add for each modules route `auth: true`:\n\n```yaml\nmodules:\n  job:\n    routes:\n      run:\n        handler:   'job_run'\n        regexp:    '^run/(?P\u003cendpoint\u003e[^\\/]+)/(?P\u003cid\u003e[a-z0-9][a-z0-9\\-]{7,63})$'\n        safe_init: true\n        auth:      true\n        op:        'POST'\n      status:\n        handler:   'job_status'\n        regexp:    '^status/(?P\u003cendpoint\u003e[^\\/]+)/(?P\u003cid\u003e[a-z0-9][a-z0-9\\-]{7,63})$'\n        auth:      true\n        op:        'GET'\n```\n\nUse section `users` to specify users allowed by endpoint:\n```yaml\n  ansible-playbook-ssh:\n    plugin: subproc\n    users:\n      maintainer: true\n      bob: true\n    config:\n      prog: ansible-playbook\n      timeout: 3600\n      args:\n        - '/etc/ansible/playbooks/ssh-install.yml'\n        - '--tags'\n        - 'sshd'\n      become:\n        enabled: true\n      env:\n        DISPLAY_SKIPPED_HOSTS: 'false'\n```\n\n### Plugin subproc\n\nsubproc plugin executes programs with python `subprocess`.\n\nPredefined AUTON environment variables during execution:\n\n| Variable           | Description                                   |\n|:-------------------|:----------------------------------------------|\n| `AUTON`            | Mark the job is executed in AUTON environment |\n| `AUTON_JOB_TIME`   | Current time in local time zone               |\n| `AUTON_JOB_GMTIME` | Current time in GMT                           |\n| `AUTON_JOB_UID`    | Current job uid passed from client            |\n| `AUTON_JOB_UUID`   | Unique ID of the current job                  |\n\nUse keyword `prog` to specify program path:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n```\n\nUse keyword `workdir` to change the working directory:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      workdir: somedir/\n```\n\nUse keyword `search_paths` to specify paths to search `prog`:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      search_paths:\n        - /usr/local/bin\n        - /usr/bin\n        - /bin\n```\n\nUse section `become` to execute with an other user:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      become:\n        enabled: true\n        user: foo\n```\n\nUse keyword `timeout` to raise an exception after n seconds (default: 60 seconds):\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      timeout: 3600\n```\n\nUse section `args` to define arguments always present:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      args:\n        - '-s'\n        - '-4'\n```\n\nUse keyword `disallow-args` to disable arguments from client:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      args:\n        - '-vvv'\n        - 'https://example.com'\n      disallow-args: true\n```\n\nUse section `argfiles` to define arguments files always present:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      argfiles:\n        - arg: '--key'\n          filepath: /tmp/private_key\n        - arg: '-d@'\n          filepath: /tmp/data\n```\n\nUse keyword `disallow-argfiles` to disable arguments files from client:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      argfiles:\n        - arg: '--key'\n          filepath: /tmp/private_key\n        - arg: '-d@'\n          filepath: /tmp/data\n      disallow-argfiles: true\n```\n\nUse section `env` to define environment variables always present:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      env:\n        HTTP_PROXY: http://proxy.example.com:3128/\n        HTTPS_PROXY: http://proxy.example.com:3128/\n```\n\nUse keyword `disallow-env` to disable environment variables from client:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      env:\n        HTTP_PROXY: http://proxy.example.com:3128/\n        HTTPS_PROXY: http://proxy.example.com:3128/\n      disallow-env: true\n```\n\nUse section `envfiles` to define environment variables files always present:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      envfiles:\n        - somedir/foo.env\n        - somedir/bar.env\n```\n\nUse keyword `disallow-envfiles` to disable environment files from client:\n```yaml\nendpoints:\n  curl:\n    plugin: subproc\n    config:\n      prog: curl\n      envfiles:\n        - somedir/foo.env\n        - somedir/bar.env\n      disallow-envfiles: true\n```\n\n## Auton command-lines\n\n### endpoint curl examples:\n\nGet URL https://example.com:\n\n`auton --endpoint curl --uri http://localhost:8666 -a 'https://example.com'`\n\nGet URL https://example.com with auton authentication:\n\n`auton --endpoint curl --uri http://localhost:8666 --auth-user foo --auth-passwd bar -a 'https://example.com'`\n\nAdd environment variable HTTP\\_PROXY:\n\n`auton --endpoint curl --uri http://localhost:8666 -a 'https://example.com' -e 'HTTP_PROXY=http://proxy.example.com:3128/'`\n\nImport already declared environment variable with argument --imp-env:\n\n`HTTPS_PROXY=http://proxy.example.com:3128/ auton --endpoint curl --uri http://localhost:8666 -a 'https://example.com' --imp-env HTTPS_PROXY`\n\nLoad environment variables from local files:\n\n`auton --endpoint curl --uri http://localhost:8666 -a 'https://example.com' --load-envfile foo.env`\n\nTell to autond to load environment variables files from its local fs:\n\n`auton --endpoint curl --uri http://localhost:8666 -a 'https://example.com' --envfile /etc/auton/auton.env`\n\nAdd multiple autond URIs for high availability:\n\n`auton --endpoint curl --uri http://localhost:8666 --uri http://localhost:8667 -a 'https://example.com'`\n\nAdd arguments files to send local files:\n\n`auton --endpoint curl --uri http://localhost:8666 -A '--cacert=cacert.pem' -a 'https://example.com'`\n\nAdd multiple arguments:\n\n`auton --endpoint curl --uri http://localhost:8666 --multi-args '-vvv -u foo:bar https://example.com' --multi-argsfiles '-d@=somedir/foo.txt -d@=bar.txt --cacert=cacert.pem'`\n\nGet file contents from stdin with `-`:\n\n`cat foo.txt | auton --endpoint curl --uri http://localhost:8666 --multi-args '-vvv -u foo:bar sftp://example.com' --multi-argsfiles '--key=private_key.pem --pubkey=public_key.pem -T=-'`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecryptus%2Fauton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecryptus%2Fauton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecryptus%2Fauton/lists"}