aboutsummaryrefslogtreecommitdiff
path: root/laurali/configuration.ts
blob: 49043107f50317e6b41ae2051d438e7c5bd60418 (plain) (blame)
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
// This file is part of Laurali <https://github.com/gemrest/laurali>.
// Copyright (C) 2022-2022 Fuwn <[email protected]>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// Copyright (C) 2022-2022 Fuwn <[email protected]>
// SPDX-License-Identifier: GPL-3.0-only

/** Configuration options of a `Server`'s HTTP proxy */
export interface ProxyConfiguration {
  /** Allow Laurali to proxy */
  enable?: boolean;
  /**
   * The base URL of the HTTP proxy server
   * @default "https://fuwn/me/proxy/"
   */
  baseURL?: string;
  /**
   * The hostname of **this** Laurali server
   * @default ServerConfiguration.hostname
   */
  hostname?: string;
}

/** Configuration options of a `Server` */
export interface ServerConfiguration {
  /** The port a `Server` will listen on */
  port?: number;
  /** The hostname a `Server` will identify as */
  hostname?: string;
  /** Proxy your Gemini content by specifying an HTTP proxy */
  proxy?: ProxyConfiguration;
}