[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/yesinteractive/restfulrelay/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","yesinteractive","reponame","restfulrelay","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2020-01-30T06:39:18.62708Z","description","PHP Based Microservice that relays remote SFTP, SSH, SMTP and more through a RESTful interface. ","is_private","last_updated","2020-01-30T22:10:02.123377Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",1085,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# Restful Relay\n![alt text](https://raw.githubusercontent.com/yesinteractive/restful_relay/master/public/restrelay.png \"restful relay microservice\")\n\n\nRestful Relay is a PHP Based Microservice that relays remote SFTP, SSH, SMTP commands through a RESTful interface. Microservice also can create JWT tokens as well as conduct request fanning. This utility works great in combination with API Gateway solution such as Kong (konghq.com), in a Kubernetes cluster, or a service mesh.\n\nDocumentation:\n- [Installation and Deployment](#install)\n- [SSH](#ssh)\n- [SFTP](#sftp)\n- [SMTP](#smtp)\n- [JWT Creation](#jwt)\n- [Request Fanning](#fan)\n- Other protocols and utlities coming soon\n\n---\n \n## Installation and Deployment Examples\n\nSee usage examples for Kubernetes, Kong for Kubernetes Ingress Controller, and docker-compose in the [examples directory folder.](https://github.com/yesinteractive/restful_relay/blob/master/examples)\n\n### With Docker\n\nDocker image is Alpine 3.9 based running on Apache. The containter exposes both ports 80 an 443 with a self signed certificated. If you wish to alter the container configuration, feel free to use the Dockerfile in this repo (https://github.com/yesinteractive/restful_relay/blob/master/Dockerfile). Otherwise, you can pull the latest image from DockerHub with the following command:\n```\ndocker pull yesinteractive/restfulrelay\n```\nTypical basic usage:\n\n```\ndocker run -it yesinteractive/restfulrelay\n```\n\nTypical usage in Dockerfile:\n\n```\nFROM yesinteractive/restfulrelay\nRUN echo \n```\n\n \n## SSH Command\n\n\nRuns SSH command on remote server. Only currently supports username password authentication. \n\n**URL** : `/ssh`\n\n**Method** : `POST`\n\n**Parameters**\n\n| Name | Description |\n| ----------- | ----------- |\n| server | Server to connect to (ie: localhost, somedomain.com, etc.) |\n| user | SSH Username |\n| pass | SSH Password |\n| command | command - combine with && (ie: date && hostname) |\n\n**Auth required** : NO\n\n### Success Response\n\n**HTTPie Request** : ```http -f POST /ssh server=localhost user=myuser pass=mypass command='php -v'```\n\n**Respones Code** : `200 OK`\n\n```json\n{\n \"Response\": {\n \"Status\": \"Success\",\n \"Response\": \"PHP 5.6.36 (cli) (built: May 18 2018 04:51:01) \\nCopyright (c) 1997-2016 The PHP Group\\nZend Engine v2.6.0, Copyright (c) 1998-2016 Zend Technologies\\n with Zend OPcache v7.0.6-dev, Copyright (c) 1999-2016, by Zend Technologies\\n\",\n \"Processing Time\": \"0.202658\"\n }\n}\n```\n\n\n\n \n## SFTP Commands\nRuns SSH command on remote server. Only currently supports username password authentication. \n\n### SFTP Get\n\n**URL** : `/sftp/get`\n\n**Method** : `POST`\n\n**Parameters**\n\n| Name | Description |\n| ----------- | ----------- |\n| server | Server to connect to (ie: localhost, somedomain.com, etc.) |\n| user | sftp Username |\n| pass | sftp Password |\n| filename | filename to fetch |\n| dir | OPTIONAL. directory of file. will use default logged in dir if not set |\n\n**Auth required** : NO\n\n### Success Response\n\n**HTTPie Request** : ```http -f POST /sftp/get server=localhost user=myuser pass=mypass filename='example.txt'```\n\n**Respones Code** : `200 OK`\n\n```json\n{\n \"Response\": {\n \"Status\": \"Success\",\n \"Response\": \"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.\",\n \"Processing Time\": \"0.173307\"\n }\n}\n```\n### SFTP Put\nWill return true if put sucessful, false if failed.\n\n**URL** : `/sftp/put`\n\n**Method** : `POST`\n\n**Parameters**\n\n| Name | Description |\n| ----------- | ----------- |\n| server | Server to connect to (ie: localhost, somedomain.com, etc.) |\n| user | sftp Username |\n| pass | sftp Password |\n| filename | filename to save |\n| data | data/text to save to file |\n| dir | OPTIONAL. directory of file. will use default logged in dir if not set |\n\n**Auth required** : NO\n\n### Success Response\n\n**HTTPie Request** : ```http -f POST /sftp/put server=localhost user=myuser pass=mypass data='sample text' filename='example.txt'```\n\n**Respones Code** : `200 OK`\n\n```json\n{\n \"Response\": {\n \"Status\": \"Success\",\n \"Response\": true,\n \"Processing Time\": \"0.177481\"\n }\n}\n```\n\n---\n\n \n## SMTP - Send Mail\n\n\nSends mail via smtp. Only currently supports username password authentication.\n\n**URL** : `/mailer`\n\n**Method** : `POST`\n\n**Parameters**\n\n| Name | Description |\n| ----------- | ----------- |\n| server | SMtp Server to connect to (ie: localhost, somedomain.com, etc.) |\n| user | smtp Username |\n| pass | smtp Password |\n| port | smtp server port |\n| from | from email address - sender|\n| from_name | from name |\n| to | to email address - recipient |\n| subject | message subject |\n| body | message body - text only currently |\n\n\n**Auth required** : NO\n\n### Success Response\n\n**HTTPie Request** : ```http -f POST /mailer server=localhost user=myuser pass=mypass port=587 from=sender@fqdn from_name=bob to=recipient@fqdn subject=hello body=world ```\n\n**Respones Code** : `200 OK`\n\n```json\n{\n \"Response\": {\n \"Status\": \"Message send successfully.\",\n \"Processing Time\": \"1.202658\"\n }\n}\n```\n\n\n\n \n## Generate JWT\n\nGenerate a JWT token. Claims returned in token will consist of id and iat.\n\n**URL** : `/jwt`\n\n**Method** : `POST`\n\n**Parameters**\n\n| Name | Description |\n| ----------- | ----------- |\n| key | Signing Key |\n| id | Client ID |\n\n**Auth required** : NO\n\n### Success Response\n\n**HTTPie Request** : ```http -f POST /jwt key=mykey id=myuser```\n\n**Respones Code** : `200 OK`\n\n```json\n{\n \"Response\": {\n \"Status\": \"Success\",\n \"JWT\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6Im15dXNlciIsImlhdCI6MTU4MDAwMDU4MH0.aQluZvipTnaglibRBNa5Z-GUi_pp0meVIjhSzn4gPt8\",\n \"ID\": \"myuser\",\n \"Processing Time\": \"0.001395\"\n }\n}\n```\n\n\n\n \n## Request Fanning\n\nFans a single request into multiple requests and then conslidate responses to one JSON Response. Please note that \nthis function assumes that the upstream responses from each URL specified will be JSON based. URL Requests are run concurrently for better speed rather than in a serial fashion which would cause greater latency.\n\n**URL** : `/fan`\n\n**Method** : `POST`\n\n**Request Data Content Type Must Be application/json**\n\nSee example below. To perform an HTTP Get, simply list the URL. If you would like to perform a post, pass the post data in a group named 'post'. Example below is showing 3 requests - 2 GETs and 1 POST.\n\n```json\n[\n {\n \"url\": \"http://dummy.restapiexample.com/api/v1/employees\"\n },\n {\n \"url\": \"http://dummy.restapiexample.com/api/v1/employees\"\n },\n {\n \"url\": \"http://dummy.restapiexample.com/api/v1/create\",\n \"post\": {\n \"appid\": \"YahooDemo\",\n \"output\": \"php\",\n \"context\": \"test\"\n }\n }\n]\n```\n\n**Auth required** : NO\n\n### Success Response\n\n**HTTPie Request** : ```http -f POST /fan ```\n\n**Respones Code** : `200 OK`\n\n```json\n[\n {\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"24\",\n \"employee_name\": \"Doris Wilder\",\n \"employee_salary\": \"85600\",\n \"employee_age\": \"23\",\n \"profile_image\": \"\"\n }\n ]\n },\n {\n \"status\": \"success\",\n \"data\": {\n \"name\": null,\n \"salary\": null,\n \"age\": null,\n \"id\": 84\n }\n }\n]\n```\n\n\n\n\n## Notes\n\n* None.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",36546255,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":61,"_124":17},"content_type","creator",3604521,"full_size",18347600,"id",84582578,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":61,"_113":-5},"architecture","amd64","digest","sha256:ff48bbb352c4a5733540cd800b46bc5c41373ac102db375d6dc13d51e263bf2d","features","","last_pulled","2026-09-22T15:39:23.558775952Z","last_pushed","2020-01-30T22:10:02Z","os","linux","os_features","os_version","size","variant","2020-01-30T22:10:01.737159Z","last_updater","last_updater_username","media_type","latest","repository",8398471,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":140,"_75":11,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":58,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":61,"_124":17},[152],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":61,"_113":-5},[],"canDeleteTags","actionData","errors"]

yesinteractive/restfulrelay

Tags for yesinteractive/restfulrelay