{"id":37119744,"url":"https://github.com/xcat2/goconserver","last_synced_at":"2026-01-14T13:57:38.381Z","repository":{"id":46188169,"uuid":"103539574","full_name":"xcat2/goconserver","owner":"xcat2","description":"Microservice based console server to help log and redirect the terminal content for multiple session hosts.","archived":false,"fork":false,"pushed_at":"2020-11-02T15:57:57.000Z","size":6982,"stargazers_count":19,"open_issues_count":12,"forks_count":21,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-08-14T03:49:02.819Z","etag":null,"topics":["console","go","logging","rest","terminal"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xcat2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.html","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-14T14:03:00.000Z","updated_at":"2024-06-08T08:35:40.000Z","dependencies_parsed_at":"2022-09-08T10:12:15.611Z","dependency_job_id":null,"html_url":"https://github.com/xcat2/goconserver","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/xcat2/goconserver","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fgoconserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fgoconserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fgoconserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fgoconserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xcat2","download_url":"https://codeload.github.com/xcat2/goconserver/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xcat2%2Fgoconserver/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28422387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T13:30:50.153Z","status":"ssl_error","status_checked_at":"2026-01-14T13:29:08.907Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["console","go","logging","rest","terminal"],"created_at":"2026-01-14T13:57:37.726Z","updated_at":"2026-01-14T13:57:38.372Z","avatar_url":"https://github.com/xcat2.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## goconserver\n\n`goconserver` is written in golang which intend to replace the `conserver`\nwhich used in [xcat2](https://github.com/xcat2/xcat-core). The microservice\nbased design makes it easy to integrate with other tool which hope to log the\nterminal sessions. It can also work independently through command line or rest\napi interface.\n\n![preview](/goconserver.gif)\n\n## Key Features\n\n- Manage the lifecycle of seesion hosts via REST or BULK REST interface.\n- Interface based desgin, support multiple types of terminal, storage and\n  output plugin. Multiple output plugins could work together.\n- Multiple client could share one host session.\n\n### Terminal plugins\n\n- ssh: SSH driver start ssh session within goruntine, As no external process,\n       goconserver could support a large number of OpenBMC\n       [openbmc](https://github.com/openbmc) consoles with high performance.\n\n- cmd: A general driver to help redirect the command input and output. Any\n       shell based terminal type could be supported.\n\n### Output plugins:\n\n- file: Store the terminal session in files for different hosts.\n- tcp:  Send the console line (splitted) in json format to the remote target\n        with tcp method.\n- udp:  Send the console line (splitted) in json format to the remote target\n        with udp method.\n\n### Storage plugins\n\n- file: Store the host information in a json file.\n- etcd: Support goconserver cluster.\n\n### Multiple client types\n\n- terminal: Get console session via TCP(or with TLS) connection.\n- web: Get console session from web terminal.\n\n![preview](/goconserver2.gif)\n\n### Design Structure\n`goconserver` can be divided into three parts:\n- daemon part: `goconserver`, expose REST api interface to define and control\n  the session host.\n\n- client part: `congo`, a command line tool to manage the configuration of\n  session hosts. A tty console client is also provided and multiple clients\n  could share the same session.\n\n- frontend part: A web page is provided to list the session status and expose\n  a web terminal for the selected node. The tty client from `congo` can share\n  the same session from web browser.\n\n## Setup goconserver from release\n\n### Setup\nDownload binary or RPM tarball from\n[goconserver](https://github.com/xcat2/goconserver/releases)\n```\nyum install \u003cgoconserver.rpm\u003e\nsystemctl start goconserver.service\n```\n\n### Configuration\nFor the server side, modify the congiguration file\n`/etc/goconserver/server.conf` based on your environment, then restart\ngoconserver service.\n\nFor client, modify the the environment variables in `/etc/profile.d/congo.sh`\nbased on your environment, then try the `congo` command. For example:\n\n```\nsource /etc/profile.d/congo.sh\ncongo list\n```\n\n### Start goconserver with xcat\n\nCurrently `xcat` and `goconserver` are integrated with `file` storage type.\nSome reference doc could be found at\n\n- [rcons](http://xcat-docs.readthedocs.io/en/latest/guides/admin-guides/manage_clusters/ppc64le/management/basic/rcons.html)\n- [gocons](http://xcat-docs.readthedocs.io/en/latest/advanced/goconserver/index.html)\n\n## Development\n\n### Requirement\n\nPlease setup golang SDK(1.9 or higher), GOPATH environment variable and\n[glide](https://github.com/Masterminds/glide) tool at first.\n\n### Build and install\n\n```\ngit clone https://github.com/xcat2/goconserver.git\ncd goconserver\nmake deps\nmake install\n```\n\n### Setup SSL/TLS (optional)\n\nPlease refer to [ssl](/scripts/ssl/)\n\n### Web Interface\n\nSetup nodejs(9.0+) and npm(5.6.0+) toolkit at first. An example steps could be\nfound at [node env](/frontend/). Then follow the steps below:\n\n```\nyum install gcc-c++\nnpm install -g gulp webpack webpack-cli\nmake frontend\n```\n\nThe frontend content is generated at `build/dist` directory. To enable it,\nmodify the configuration in `/etc/gconserver/server.conf` like below, then\nrestart `goconserver` service. The web url is available on\n`http(s)://\u003cip or domain name\u003e:\u003capi-port\u003e/`.\n```\napi:\n  dist_dir : \"\u003cdist directory\u003e\"\n```\n\n## Command Example\n\n### Start service\n```\ngoconserver \u0026                     # for debug\nservice goconserver start         # only support systemd system\n```\n### Define testnode node session\ncongo is the client command. Use congo help to see the detail.\n```\ncongo create testnode driver=ssh ondemand=false --params user=root,host=10.5.102.73,port=22,password=\u003cpassword\u003e\n```\nor with ssh private key\n```\ncongo create testnode driver=ssh ondemand=false --params user=root,host=10.5.102.73,port=22,private_key=\u003cpriavte_key_path\u003e\n```\nor general command driver\n```\ncongo create testnode driver=cmd ondemand=false --params cmd=\"ssh -l root -p 22 10.5.102.73\"\n```\n\n### List or show detail\n```\ncongo list\ncongo show testnode\n```\n\n### Connect to the testnode session\n```\ncongo console testnode\n```\n\n## Rest API\n\nRest api support bulk interface to manage the console sessions.\nPlease refer to [rest api](/api/) for detail.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxcat2%2Fgoconserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxcat2%2Fgoconserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxcat2%2Fgoconserver/lists"}