diff --git a/docs/api/settings.md b/docs/api/settings.md index f785814..12dac5e 100644 --- a/docs/api/settings.md +++ b/docs/api/settings.md @@ -38,7 +38,7 @@ The result looks like this: ## Updating the settings -To update the currently active settings, send a POST requests to the `/api/settings` endpoint. +To update the currently active settings, send a POST request to the `/api/settings` endpoint. The endpoint expects you to send the following data: @@ -53,4 +53,4 @@ messages.invalid_auth_token: STRING messages.subdomain_taken: STRING ``` -You will receive a response containing the updated configuration as JSON. \ No newline at end of file +You will receive a response containing the updated configuration as JSON. diff --git a/docs/api/users.md b/docs/api/users.md index bae86bc..5086407 100644 --- a/docs/api/users.md +++ b/docs/api/users.md @@ -69,4 +69,4 @@ This will return a response containing the generated user: To delete a user on the expose server, you can perform a DELETE request to the `/api/users/{user_id}` endpoint. -> **Note:** The users currently active shared sites will not be disconnected automatically. \ No newline at end of file +> **Note:** The user's currently active shared sites will not be disconnected automatically. diff --git a/docs/getting-started/sharing-your-first-site.md b/docs/getting-started/sharing-your-first-site.md index a1795fc..225ba24 100644 --- a/docs/getting-started/sharing-your-first-site.md +++ b/docs/getting-started/sharing-your-first-site.md @@ -37,4 +37,4 @@ To register and use the given credentials, just run the following command: expose token [YOUR-AUTH-TOKEN] ``` -This will register the token globally in your expose configuration file, and all following expose calls, will automatically use the token to authenticate with the server. \ No newline at end of file +This will register the token globally in your expose configuration file, and all following expose calls will automatically use the token to authenticate with the server. diff --git a/docs/server/admin-interface.md b/docs/server/admin-interface.md index f0156ae..05cfe93 100644 --- a/docs/server/admin-interface.md +++ b/docs/server/admin-interface.md @@ -5,7 +5,7 @@ order: 3 # Admin Interface -The Expose server comes with a beautiful admin interface, that makes configuring your server a breeze. +The Expose server comes with a beautiful admin interface that makes configuring your server a breeze. The admin interface is available at a specific subdomain on your expose server. By default it is called "expose", but you can change this in the configuration file: @@ -27,14 +27,14 @@ The admin interface is available at a specific subdomain on your expose server. ... ``` -So you can reach the admin interface at http://expose.your-domaion.com. +So you can reach the admin interface at http://expose.your-domain.com. ## Authentication Since the expose admin interface allows you to change and modify your expose server configuration at runtime, access to the admin interface is protected using basic authentication. You can define which user/password combinations are allowed in the configuration file: -> **Note:** You will need to restart your expose server, once you change this setting in order for the changes to take effect. +> **Note:** You will need to restart your expose server once you change this setting in order for the changes to take effect. ``` ... @@ -63,13 +63,13 @@ You can define which user/password combinations are allowed in the configuration Here you can list, add and delete all users that you want to be able to connect to your expose server. The users will be stored in a SQLite database that can be modified in the expose configuration file. -You only need to add users to your expose server, if you have the auth token validation enabled. +You only need to add users to your expose server if you have the auth token validation enabled. ### Shared sites ![](/img/expose_admin.png) -Once you and others start sharing their local sites with your server, you can see a list of all connectes sites here. +You can see a list of all connected sites here once you and others start sharing their local sites with your server. You can see the original client host that was shared, the subdomain that was associated to this and the time and date the site was shared. The expose server can also disconnect a site from the server. Just press on the "Disconnect" button and the client connection will be closed. @@ -78,4 +78,4 @@ The expose server can also disconnect a site from the server. Just press on the ![](/img/expose_settings.png) -Here you can see and modify your Expose server settings. \ No newline at end of file +Here you can see and modify your Expose server settings. All settings that the UI offers can also be manually edited in the expose configuration file. diff --git a/docs/server/server-configuration.md b/docs/server/server-configuration.md index affac1c..450e0b9 100644 --- a/docs/server/server-configuration.md +++ b/docs/server/server-configuration.md @@ -5,7 +5,7 @@ order: 5 # Server Configuration -Within the Expose admin interface, you can configure how you want your specific expose server to behave. +Within the Expose admin interface you can configure how you want your specific expose server to behave. Here are the available settings: @@ -31,4 +31,4 @@ This message will be shown when a user tries to connect with an invalid authenti ## Subdomain taken -This message will be shown when a user tries to connect with an already registered subdomain. This could be any user-registered subdomain, as well as the expose admin dashboard subdomain. \ No newline at end of file +This message will be shown when a user tries to connect with an already registered subdomain. This could be any user-registered subdomain, as well as the expose admin dashboard subdomain. diff --git a/docs/server/ssl.md b/docs/server/ssl.md index 19fad52..dc29612 100644 --- a/docs/server/ssl.md +++ b/docs/server/ssl.md @@ -5,9 +5,9 @@ order: 2 # SSL Support -Once your Expose server is running, you can onyl access it over the port that you configure when the server gets started. +Once your Expose server is running, you can only access it over the port that you configure when the server gets started. -If you want to enable SSL support, you will need to use a proxy service - like Nginx, HAProxy or Caddy - to handle the SSL configurations and proxy all requests in plain HTTP to your expose server. +If you want to enable SSL support, you will need to use a proxy service - like Nginx, HAProxy or Caddy - to handle the SSL configurations and proxy all non-SSL requests to your expose server. A basic Nginx configuration would look like this, but you might want to tweak the SSL parameters to your liking. @@ -36,4 +36,4 @@ server { proxy_cache_bypass $http_upgrade; } } -``` \ No newline at end of file +``` diff --git a/docs/server/starting-the-server.md b/docs/server/starting-the-server.md index f016d11..1218da2 100644 --- a/docs/server/starting-the-server.md +++ b/docs/server/starting-the-server.md @@ -31,7 +31,7 @@ When you start your expose server, anyone is able to connect to it by default. I expose serve my-domain.com --validateAuthTokens ``` -Don't worry - you can also changes this later on through the admin interface. +Don't worry - you can also change this later on through the admin interface. ## Keeping the expose server running with supervisord @@ -46,6 +46,9 @@ apt install supervisor # On Red Hat / CentOS yum install supervisor systemctl enable supervisord + +# On Mac +brew install supervisor ``` Once installed, add a new process that `supervisor` needs to keep running. You place your configurations in the `/etc/supervisor/conf.d` (Debian/Ubuntu) or `/etc/supervisord.d` (Red Hat/CentOS) directory. @@ -119,4 +122,4 @@ return [ // ... ``` -Now that your basic expose server is running, let's take a look at how you can add SSL support. \ No newline at end of file +Now that your basic expose server is running, let's take a look at how you can add SSL support. diff --git a/resources/views/server/settings/index.twig b/resources/views/server/settings/index.twig index 8f36d07..d44f1ce 100644 --- a/resources/views/server/settings/index.twig +++ b/resources/views/server/settings/index.twig @@ -51,7 +51,7 @@ v-model="configuration.messages.message_of_the_day" class="form-textarea block w-full transition duration-150 ease-in-out sm:text-sm sm:leading-5"> -

This message will be shown, when a +

This message will be shown when a successful connection can be established.

@@ -86,7 +86,7 @@ v-model="configuration.messages.invalid_auth_token" class="form-textarea block w-full transition duration-150 ease-in-out sm:text-sm sm:leading-5"> -

This message will be shown, when a +

This message will be shown when a user tries to connect with an invalid authentication token.

@@ -103,7 +103,7 @@ v-model="configuration.messages.subdomain_taken" class="form-textarea block w-full transition duration-150 ease-in-out sm:text-sm sm:leading-5"> -

This message will be shown, when a +

This message will be shown when a user tries to connect with an already registered subdomain. You can use :subdomain as a placeholder.