bitinflow/expose
1
0
Fork 0
mirror of https://github.com/bitinflow/expose.git synced 2026-03-13 13:35:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

wip

Browse Source
This commit is contained in:
Marcel Pociot
2020-06-16 00:09:04 +02:00
parent 4a56890862
commit 645330f08f
8 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/settings.md
View File

@@ -38,7 +38,7 @@ The result looks like this:
## Updating the settings ## 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: The endpoint expects you to send the following data:

2
docs/api/users.md
View File

@@ -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. 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. > **Note:** The user's currently active shared sites will not be disconnected automatically.

2
docs/getting-started/sharing-your-first-site.md
View File

@@ -37,4 +37,4 @@ To register and use the given credentials, just run the following command:
expose token [YOUR-AUTH-TOKEN] 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. 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.

12
docs/server/admin-interface.md
View File

@@ -5,7 +5,7 @@ order: 3
# Admin Interface # 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: 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 ## 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. 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: 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. 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. 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 ### Shared sites
![](/img/expose_admin.png) ![](/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. 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. 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) ![](/img/expose_settings.png)
Here you can see and modify your Expose server settings. 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.

2
docs/server/server-configuration.md
View File

@@ -5,7 +5,7 @@ order: 5
# Server Configuration # 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: Here are the available settings:

4
docs/server/ssl.md
View File

@@ -5,9 +5,9 @@ order: 2
# SSL Support # 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. A basic Nginx configuration would look like this, but you might want to tweak the SSL parameters to your liking.

5
docs/server/starting-the-server.md
View File

@@ -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 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 ## Keeping the expose server running with supervisord
@@ -46,6 +46,9 @@ apt install supervisor
# On Red Hat / CentOS # On Red Hat / CentOS
yum install supervisor yum install supervisor
systemctl enable supervisord 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. 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.

6
resources/views/server/settings/index.twig
View File

@@ -51,7 +51,7 @@
v-model="configuration.messages.message_of_the_day" 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"></textarea> class="form-textarea block w-full transition duration-150 ease-in-out sm:text-sm sm:leading-5"></textarea>
</div> </div>
<p class="mt-2 text-sm text-gray-500">This message will be shown, when a <p class="mt-2 text-sm text-gray-500">This message will be shown when a
successful connection can be established.</p> successful connection can be established.</p>
</div> </div>
</div> </div>
@@ -86,7 +86,7 @@
v-model="configuration.messages.invalid_auth_token" 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"></textarea> class="form-textarea block w-full transition duration-150 ease-in-out sm:text-sm sm:leading-5"></textarea>
</div> </div>
<p class="mt-2 text-sm text-gray-500">This message will be shown, when a <p class="mt-2 text-sm text-gray-500">This message will be shown when a
user tries to connect with an invalid authentication token.</p> user tries to connect with an invalid authentication token.</p>
</div> </div>
</div> </div>
@@ -103,7 +103,7 @@
v-model="configuration.messages.subdomain_taken" v-model="configuration.messages.subdomain_taken"
class="form-textarea block w-full transition duration-150 ease-in-out sm:text-sm sm:leading-5"></textarea> class="form-textarea block w-full transition duration-150 ease-in-out sm:text-sm sm:leading-5"></textarea>
</div> </div>
<p class="mt-2 text-sm text-gray-500">This message will be shown, when a <p class="mt-2 text-sm text-gray-500">This message will be shown when a
user tries to connect with an already registered subdomain. You can use user tries to connect with an already registered subdomain. You can use
<code class="font-mono bg-gray-500 text-white p-1">:subdomain</code> as <code class="font-mono bg-gray-500 text-white p-1">:subdomain</code> as
a placeholder.</p> a placeholder.</p>