kryptic-api/kryptic-api.xml at main · KristianKalm/kryptic-api · GitHub

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?xml version="1.0"?>
<Container version="2">
  <Name>kryptic-api</Name>
  <Repository>kalmkalm/kryptic-api</Repository>
  <Registry>https://hub.docker.com/r/kalmkalm/kryptic-api/</Registry>
  <Network>bridge</Network>
  <Shell>sh</Shell>
  <Privileged>false</Privileged>
  <Overview>Kryptic API - FastAPI backend service for Kryptic apps.</Overview>
  <Category>Tools:</Category>
  <WebUI>http://[IP]:[PORT:11213]/docs</WebUI>
  <ExtraParams>--pids-limit 2048</ExtraParams>

  <!-- Port -->
  <Config
    Name="API Port"
    Target="11213"
    Default="11213"
    Mode="tcp"
    Description="Port the API listens on."
    Type="Port"
    Display="always"
    Required="true"
    Mask="false">11213</Config>

  <!-- Paths -->
  <Config
    Name="App Data"
    Target="/app/appData"
    Default="/mnt/user/appdata/kryptic-api/appData"
    Mode="rw"
    Description="Persistent storage for user data and conf.json. Copy your conf.json into this folder on the host before first start."
    Type="Path"
    Display="always"
    Required="true"
    Mask="false">/mnt/user/appdata/kryptic-api/appData</Config>

  <!-- Variables -->
  <Config
    Name="Timezone"
    Target="TZ"
    Default="Europe/London"
    Mode=""
    Description="Timezone for the container (e.g. Europe/Kiev, America/New_York)."
    Type="Variable"
    Display="always"
    Required="false"
    Mask="false">Europe/London</Config>

  <Config
    Name="API Listen Port"
    Target="PORT"
    Default="11213"
    Mode=""
    Description="Port uvicorn listens on inside the container. Must match the port mapping above."
    Type="Variable"
    Display="advanced"
    Required="false"
    Mask="false">11213</Config>

</Container>