This repository has been archived by the owner on May 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.html
141 lines (126 loc) · 6.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
<!-- Primary Meta Tags -->
<title>qValet: trigger commands from HTTP requests</title>
<meta name="title" content="qValet: trigger commands from HTTP requests">
<meta name="description" content="qValet listens for HTTP requests and executes commands on demand">
<link rel="canonical" href="https://cmaster11.github.io/qvalet/"/>
<!-- Open Graph / Facebook -->
<meta property="og:type" content="website">
<meta property="og:url" content="https://cmaster11.github.io/qvalet/">
<meta property="og:title" content="qValet: trigger commands from HTTP requests">
<meta property="og:description" content="qValet listens for HTTP requests and executes commands on demand">
<meta property="og:image" content="https://cmaster11.github.io/qvalet/assets/qValet.png">
<!-- Twitter -->
<meta property="twitter:card" content="summary_large_image">
<meta property="twitter:url" content="https://cmaster11.github.io/qvalet/">
<meta property="twitter:title" content="qValet: trigger commands from HTTP requests">
<meta property="twitter:description" content="qValet listens for HTTP requests and executes commands on demand">
<meta property="twitter:image" content="https://cmaster11.github.io/qvalet/assets/qValet.png">
<link rel="icon" type="image/png" sizes="32x32" href="./assets/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="./assets/favicon-16x16.png">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4.12.1/lib/themes/vue.css">
</head>
<body>
<div data-app id="main">
<h1 id="qvalet">qValet</h1>
<p><a href="https://www.buymeacoffee.com/cmaster11"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt=""Buy Me A Coffee""></a></p>
<p>qValet listens for HTTP requests and executes commands on demand.</p>
<p><a href="https://github.com/cmaster11/qvalet/releases"><img src="https://img.shields.io/github/v/release/cmaster11/qvalet?sort=semver" alt="GitHub release (latest SemVer)"></a>
<img src="https://img.shields.io/github/downloads/cmaster11/qvalet/total" alt="GitHub all releases"></p>
<h2 id="view-docs-at-httpscmaster11githubioqvalet">View <strong>docs</strong> at <a href="https://cmaster11.github.io/qvalet/#/0010-getting-started">https://cmaster11.github.io/qvalet/</a></h2>
<p>Links:</p>
<ul>
<li><a href="https://hub.docker.com/r/cmaster11/qvalet/tags?page=1&ordering=last_updated">Docker image</a></li>
<li><a href="https://cmaster11.github.io/qvalet/#/0120-use-cases/">Some use cases</a></li>
</ul>
<h2 id="feature-list">Feature list</h2>
<ul>
<li>Command execution with <a href="https://cmaster11.github.io/qvalet/#/0030-templates">templatable</a> fields (command, arguments, environment variables, etc…)</li>
<li>Some built-in <a href="https://cmaster11.github.io/qvalet/#/0060-authentication">authentication</a> methods</li>
<li><a href="https://cmaster11.github.io/qvalet/#/0050-storage">Storage</a> for payloads and execution results</li>
<li><a href="https://cmaster11.github.io/qvalet/#/0080-trigger-conditions">Trigger conditions</a> to evaluate if a command should be run or not</li>
<li><a href="https://cmaster11.github.io/qvalet/#/0110-plugins/awssns">AWS SNS</a> support, to automatically accept subscription requests and receive AWS SNS messages</li>
<li><a href="https://cmaster11.github.io/qvalet/#/0110-plugins/schedule">Scheduled tasks</a>, to execute commands in the future</li>
<li>And more!</li>
</ul>
<h2 id="example">Example</h2>
<pre><code class="hljs language-yaml"><span class="hljs-attr">listeners:</span>
<span class="hljs-string">/hello:</span>
<span class="hljs-comment"># Returns the output of the command in the response</span>
<span class="hljs-attr">return:</span> <span class="hljs-string">output</span>
<span class="hljs-comment"># Command to run, and list of arguments</span>
<span class="hljs-attr">command:</span> <span class="hljs-string">bash</span>
<span class="hljs-attr">args:</span>
<span class="hljs-bullet">-</span> <span class="hljs-string">-c</span>
<span class="hljs-comment"># You can use templates to customize commands/arguments/env vars</span>
<span class="hljs-bullet">-</span> <span class="hljs-string">|</span>
<span class="hljs-string">echo</span> <span class="hljs-string">"Hello <span class="hljs-template-variable">{{ .name }}</span>"</span>
</code></pre>
<p>Tested with:</p>
<pre><code class="hljs language-bash">curl <span class="hljs-string">"http://localhost:7055/hello?name=Mr.%20Anderson"</span>
</code></pre>
<p>Will return:</p>
<pre><code class="hljs language-bash">{<span class="hljs-string">"output"</span>:<span class="hljs-string">"Hello Mr. Anderson\n"</span>}
</code></pre>
</div>
<script>
window.$docsify = {
basePath: './docs',
el: '#main',
homepage: 'README.md',
loadNavbar: '_navbar.md',
loadSidebar: '_sidebar.md',
subMaxLevel: 6,
alias: {
'/.*/_navbar.md': '/_navbar.md',
'/.*/_sidebar.md': '/_sidebar.md'
},
auto2top: true,
repo: 'https://github.com/cmaster11/qvalet',
autoHeader: true,
mergeNavbar: true,
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@4.12.1"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-go.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-yaml.min.js"></script>
<script type="text/javascript">
window.doorbellOptions = {
'id': '12605',
'appKey': 'KZFPSNHnzr5u6P9dkYoNyXLmjvVHXMOKRksSnMJrAjQRMigMHTHnYWC4LjsvP44t'
};
(function (w, d, t) {
var hasLoaded = false;
function l() {
if (hasLoaded) {
return;
}
hasLoaded = true;
window.doorbellOptions.windowLoaded = true;
var g = d.createElement(t);
g.id = 'doorbellScript';
g.type = 'text/javascript';
g.async = true;
g.src = 'https://embed.doorbell.io/button/' + window.doorbellOptions['id'] + '?t=' + (new Date().getTime());
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(g);
}
if (w.attachEvent) {
w.attachEvent('onload', l);
} else if (w.addEventListener) {
w.addEventListener('load', l, false);
} else {
l();
}
if (d.readyState == 'complete') {
l();
}
}(window, document, 'script'));
</script>
</body>
</html>