This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
trigger:Web_Server [2018/07/15 01:29] JMichaelTX Major rewrite with screenshots and section headers |
trigger:Web_Server [2018/07/16 03:21] JMichaelTX Clarified use of 4490 vs 4491; Change all to localhost |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{:trigger:web-server-icon.png?nolink|}} | ||
+ | |||
====== Web Server ====== | ====== Web Server ====== | ||
===== Overview ===== | ===== Overview ===== | ||
- | If the Keyboard Maestro web server is enabled, then you can connect to it using your web browser.\\ | + | If the Keyboard Maestro web server is enabled, then you can connect to it using your web browser. |
- | :!: Note: A HTTP Port of 4490 is used in all examples on this page. But it can be set to any port you prefer. | + | |
- | **To Display the Web Server User Interface** | + | :!: Note: A HTTP Port of 4490 or 4491 is used in all examples on this page. But it can be set to any port you prefer. |
- | ```html | + | |
- | http://127.0.0.1:4490/ | + | **To Display the Web Server User Interface**\\ |
+ | (you can use either `127.0.0.1` or `localhost`. They are equivalent.) | ||
``` | ``` | ||
+ | http://127.0.0.1:4490 <!- for normal connection -> | ||
+ | http://localhost:4490 <!- for normal connection -> | ||
+ | https://localhost:4491 <!- for secure connection -> | ||
+ | ``` | ||
+ | |||
If you have configured a username and password for the web server, then you can log in and execute any active macro. You do not need to explicitly set a trigger, if you enable the web server, and configure a username and password, then all active macros can be executed via the web browser using the username and password. | If you have configured a username and password for the web server, then you can log in and execute any active macro. You do not need to explicitly set a trigger, if you enable the web server, and configure a username and password, then all active macros can be executed via the web browser using the username and password. | ||
- | Any macro with the [[Public Web]] trigger can be triggered by anyone without the username or password. | + | Any macro with the [[Public Web]] trigger can be triggered by anyone without the username or password as long as they can connect to your Mac. |
+ | |||
+ | For most home users, only computers on your local network can connect, although it depends on your network setup. Potentially anyone on the Internet can connect to the server. | ||
**To Execute a Specific Macro** | **To Execute a Specific Macro** | ||
```html | ```html | ||
- | http://127.0.0.1:4490/action.html?macro=<YourMacroUUID>&value=<TheTriggerValueToPass> | + | https://localhost:4491/action.html?macro=<YourMacroUUID>&value=<TheTriggerValueToPass> |
``` | ``` | ||
- | --- | ||
===== Enable and Setup Web Server ===== | ===== Enable and Setup Web Server ===== | ||
Line 30: | Line 38: | ||
|**Web Server Enabled** | _unchecked_ | Must be _checked_ in order to use the Keyboard Maestro Web Server.\\ If _checked_, then the below fields need to be completed. | | |**Web Server Enabled** | _unchecked_ | Must be _checked_ in order to use the Keyboard Maestro Web Server.\\ If _checked_, then the below fields need to be completed. | | ||
| HTTP Port | 4490 | _Required_. The Port used in the `URL` to access the Server. HTTPS port is `<HTTP Port> + 1`.\\ Normally you leave this at default value, unless you already have that Port assigned to something else in your router. | | | HTTP Port | 4490 | _Required_. The Port used in the `URL` to access the Server. HTTPS port is `<HTTP Port> + 1`.\\ Normally you leave this at default value, unless you already have that Port assigned to something else in your router. | | ||
- | | Username | `<NONE>` | _Required_. Enter any name you prefer, but pick one that you will remember. | | + | | Username | `<NONE>` | _Required for authenticated access_. Enter any name you prefer, but pick one that you will remember. | |
- | | Password | `<NONE>` | _Required_. Although there are no specific requirements for the password, you should pick a strong one that you will remember, or better, use a Password Manager. | | + | | Password | `<NONE>` | _Required for authenticated access_. Although there are no specific requirements for the password, you should pick a strong one that you will remember, or better, use a Password Manager. | |
- | | Web Browser Access Enabled | _checked_ | This must be checked in order to use the `URL` in a web browser. | | + | | Web Browser Access Enabled | _checked_ | This must be checked in order to Keyboard Maestro Control on an iOS device. | |
- | | iOS Access Enabled | _unchecked_ | Must be checked in order to use from an iOS device.\\ FIXME: _does this require the KM iOS app?_ | | + | | Receive Clipboards into Clipboard History | _unchecked_ | If checked, you can send your clipboard from on Mac to another using the Clipboard History Switcher. | |
- | | Receive Clipboards into Clipboard History | _unchecked_ | FIXME: _what does this mean???_ | | + | | Replacing Current Clipboard | _unchecked_ | If checked, received clipboards will replace your current system clipboard, otherwise they will be added to the clipboard history as the immediate paste clipboard. | |
- | | Replacing Current Clipboard | _unchecked_ | FIXME: _meaning???_ | | + | |
- | --- | ||
===== How To Use ===== | ===== How To Use ===== | ||
Line 48: | Line 55: | ||
- Then anyone on the Internet (with access to your local area network) trigger _only_ those macros that have set the [[Public Web]] trigger. Of course, if you properly setup your Internet router, unauthorized access from the Internet should be very unlikely. | - Then anyone on the Internet (with access to your local area network) trigger _only_ those macros that have set the [[Public Web]] trigger. Of course, if you properly setup your Internet router, unauthorized access from the Internet should be very unlikely. | ||
- | FIXME: _What happens if you do NOT enter a username/password?_ | + | If you have not entered a username or password, then you will not be able to login, but any Public Web triggered macros will still be available (as long as the web server is enabled). |
- | **Connecting to Keyboard Maestro Web Server in Safari**\\ | + | **Connecting to Keyboard Maestro Web Server in Safari** |
- | `URL: http://127.0.0.1:4490` | + | |
- | {{:trigger:km-server-in-safari.png?nolink|}} | + | ``` |
+ | URL: https://localhost:4491 | ||
+ | ``` | ||
- | --- | + | {{:trigger:km-server-in-safari.png?nolink|}} |
===== See Also ===== | ===== See Also ===== | ||
Line 71: | Line 79: | ||
* [MACRO: @Web Open URL Passed from KM Public Web Server](https://forum.keyboardmaestro.com/t/open-url-passed-from-km-public-web-server/7019) | * [MACRO: @Web Open URL Passed from KM Public Web Server](https://forum.keyboardmaestro.com/t/open-url-passed-from-km-public-web-server/7019) | ||
* [Triggering Keyboard Maestro macros remotely, KM8, Peter Lewis](https://forum.keyboardmaestro.com/t/triggering-keyboard-maestro-macros-remotely/8277) | * [Triggering Keyboard Maestro macros remotely, KM8, Peter Lewis](https://forum.keyboardmaestro.com/t/triggering-keyboard-maestro-macros-remotely/8277) | ||
- | |||
- | |||