# Getting started

The extensions server can run in 2 ways:

* **\[Recommended]** Via configuration (`config.yml`) file that’s on the same machine,
* Or with command-line arguments.

Because the extension server is cross platform there are multiple binaries with\
different file extensions.

* Windows: `extension-name.exe`
* Linux: `extension-name`

Example of a configuration file `config.yml`:

```yaml
—
## This configuration file will be used for building as well.
## Configuration will be merged into the options/arguments list.
## In production there will be a more stripped version
server:
## Host includes port if necessary. Do not include when running on :80 or :443
## example: extension.company.com
host: localhost:8000
## Set custom base path for the extension on a domain “custom-extension” e.g.
## localhost:8080/custom-extension/
base: /
## Enable HTTPS for the webserver can be done here
## In case you want to use the .pfx certificate
## uncomment the `key` and `cert` property, using #
https:
# key: ../ssl/localhost.key
## or localhost.cert
# cert: ../ssl/localhost.crt
## or when on windows and want to use a .pfx file
# pfx: ../ssl/localhost.pfx
# passphrase: some-passphrase
## Change the license configuration
license:
## When not set, it will check for a `license.lic` or `LICENSE` file and
## load license in the current directory.
Example in current folder:
# file: ./license.lic
Example in different folder:
# file: ../enterprise_licenses/license.lic
```

### Running with a reversed proxy?

To run behind a reversed proxy use the local domain as host. To generate a correct trex file, it is important that you configure the public facing URL as host in the`config.yaml` file under a `trex` section:

```yaml
trex:
  ## Fixed host for the generated trex file, needed when using a reversed proxy.
  host: 'https://my-extension-url.company.com'
```

All options for using the extension server in command-line mode, without config:

```bash
Usage: super-tables [options]

Options:

–config [config]	    Change config file. Yaml formatted file.
-l, –license [file]	    Use license file. Do not use when next to binary.
-s, –static [path…]	    Add static routes to serve directly. Runtime static files. Path must be relative from the binary directory.
-b, –base [base-path]	    Base path to serve from.
–debug	                    Run the application in debug mode.
-h, –host [port]	    The host of the domain with port.. (default: “:8000”)
–key [key]	            Relative path `key` file for SSL. requires –cert to be passed.
–cert [cert]	            Relative path `cert` file for SSL. requires –key to be passed.
–pfx [pfx]	            Relative path to Windows PFX file for SSL/HTTPS. requires –passphrase to be passed.
–passphrase [passphrase]    Relative path passphrase for .pfx and encrypted .key files for SSL/HTTPS. requires –pfx or –key to be passed.
–help	                    Display help for command
```

{% hint style="info" %}
Please note that this example can change in upcoming versions.
{% endhint %}

### Choose your installation guide

<table data-card-size="large" data-column-title-hidden data-view="cards" data-full-width="true"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3>Windows</h3></td><td>How todo the installation on a Windows Server.</td><td></td><td><a href="/pages/z2w9pk27ewPTrzCcr6rn">/pages/z2w9pk27ewPTrzCcr6rn</a></td></tr><tr><td><h3>Linux</h3></td><td>Installation guide for Linux servers.</td><td></td><td><a href="/pages/upB521hIKKywEj1NpMYI">/pages/upB521hIKKywEj1NpMYI</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.infotopics.com/enterprise-installation/installation-guide/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
