LAB-linuxserver/docker-lsio-api
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-lsio-api.git synced 2026-02-20 08:40:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from linuxserver/initial

Browse Source 
Initial
This commit is contained in:
quietsy 2025-02-08 16:55:43 +02:00 committed by GitHub
commit d7451d33af
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
38 changed files with 3373 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
.editorconfig Executable file
View File

@ -0,0 +1,20 @@
# This file is globally distributed to all container image projects from
# https://github.com/linuxserver/docker-jenkins-builder/blob/master/.editorconfig
# top-most EditorConfig file
root = true
# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
# trim_trailing_whitespace may cause unintended issues and should not be globally set true
trim_trailing_whitespace = false
[{Dockerfile*,**.yml}]
indent_style = space
indent_size = 2
[{**.sh,root/etc/s6-overlay/s6-rc.d/**,root/etc/cont-init.d/**,root/etc/services.d/**}]
indent_style = space
indent_size = 4

123
.github/CONTRIBUTING.md vendored Executable file
View File

@ -0,0 +1,123 @@
# Contributing to lsio-api
## Gotchas
* While contributing make sure to make all your changes before creating a Pull Request, as our pipeline builds each commit after the PR is open.
* Read, and fill the Pull Request template
* If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR
* If the PR is addressing an existing issue include, closes #\<issue number>, in the body of the PR commit message
* If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://linuxserver.io/discord)
## Common files
| File | Use case |
| :----: | --- |
| `Dockerfile` | Dockerfile used to build amd64 images |
| `Dockerfile.aarch64` | Dockerfile used to build 64bit ARM architectures |
| `Dockerfile.armhf` | Dockerfile used to build 32bit ARM architectures |
| `Jenkinsfile` | This file is a product of our builder and should not be edited directly. This is used to build the image |
| `jenkins-vars.yml` | This file is used to generate the `Jenkinsfile` mentioned above, it only affects the build-process |
| `package_versions.txt` | This file is generated as a part of the build-process and should not be edited directly. It lists all the installed packages and their versions |
| `README.md` | This file is a product of our builder and should not be edited directly. This displays the readme for the repository and image registries |
| `readme-vars.yml` | This file is used to generate the `README.md` |
## Readme
If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit.
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-lsio-api/edit/main/readme-vars.yml).
These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play.
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io)
### Fixing typos or clarify the text in the readme
There are variables for multiple parts of the readme, the most common ones are:
| Variable | Description |
| :----: | --- |
| `project_blurb` | This is the short excerpt shown above the project logo. |
| `app_setup_block` | This is the text that shows up under "Application Setup" if enabled |
### Parameters
The compose and run examples are also generated from these variables.
We have a [reference file](https://github.com/linuxserver/docker-jenkins-builder/blob/master/vars/_container-vars-blank) in our Jenkins Builder.
These are prefixed with `param_` for required parameters, or `opt_param` for optional parameters, except for `cap_add`.
Remember to enable param, if currently disabled. This differs between parameters, and can be seen in the reference file.
Devices, environment variables, ports and volumes expects its variables in a certain way.
### Devices
```yml
param_devices:
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
opt_param_devices:
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
```
### Environment variables
```yml
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
opt_param_env_vars:
- { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." }
```
### Ports
```yml
param_ports:
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
opt_param_ports:
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
```
### Volumes
```yml
param_volumes:
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
opt_param_volumes:
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
```
### Testing template changes
After you make any changes to the templates, you can use our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) to have the files updated from the modified templates. Please use the command found under `Running Locally` [on this page](https://github.com/linuxserver/docker-jenkins-builder/blob/master/README.md) to generate them prior to submitting a PR.
## Dockerfiles
We use multiple Dockerfiles in our repos, this is because sometimes some CPU architectures needs different packages to work.
If you are proposing additional packages to be added, ensure that you added the packages to all the Dockerfiles in alphabetical order.
### Testing your changes
```bash
git clone https://github.com/linuxserver/docker-lsio-api.git
cd docker-lsio-api
docker build \
--no-cache \
--pull \
-t linuxserver/lsio-api:latest .
```
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
```bash
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## Update the changelog
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-lsio-api/tree/main/root), add an entry to the changelog
```yml
changelogs:
- { date: "DD.MM.YY:", desc: "Added some love to templates" }
```

2
.github/FUNDING.yml vendored Executable file
View File

@ -0,0 +1,2 @@
github: linuxserver
open_collective: linuxserver

13
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,13 @@
blank_issues_enabled: false
contact_links:
- name: Discord chat support
url: https://linuxserver.io/discord
about: Realtime support / chat with the community and the team.
- name: Discourse discussion forum
url: https://discourse.linuxserver.io
about: Post on our community forum.
- name: Documentation
url: https://docs.linuxserver.io
about: Documentation - information about all of our containers.

68
.github/ISSUE_TEMPLATE/issue.bug.yml vendored Executable file
View File

@ -0,0 +1,68 @@
# Based on the issue template
name: Bug report
description: Create a report to help us improve
title: "[BUG] <title>"
labels: [Bug]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: Tell us what happens instead of the expected behavior.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: Tell us what should happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **How docker service was installed**: distro's packagemanager
value: |
- OS:
- How docker service was installed:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Docker creation
description: |
Command used to create docker container
Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container
render: bash
validations:
required: true
- type: textarea
attributes:
description: |
Provide a full docker log, output of "docker logs lsio-api"
label: Container logs
placeholder: |
Output of `docker logs lsio-api`
render: bash
validations:
required: true

31
.github/ISSUE_TEMPLATE/issue.feature.yml vendored Executable file
View File

@ -0,0 +1,31 @@
# Based on the issue template
name: Feature request
description: Suggest an idea for this project
title: "[FEAT] <title>"
labels: [enhancement]
body:
- type: checkboxes
attributes:
label: Is this a new feature request?
description: Please search to see if a feature request already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Wanted change
description: Tell us what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Reason for change
description: Justify your request, why do you want it, what is the benefit.
validations:
required: true
- type: textarea
attributes:
label: Proposed code change
description: Do you have a potential code change in mind?
validations:
required: false

43
.github/PULL_REQUEST_TEMPLATE.md vendored Executable file
View File

@ -0,0 +1,43 @@
<!--- Provide a general summary of your changes in the Title above -->
[linuxserverurl]: https://linuxserver.io
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
<!--- Before submitting a pull request please check the following -->
<!--- If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR -->
<!--- Ask yourself if this modification is something the whole userbase will benefit from, if this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
<!--- We maintain a changelog of major revisions to the container at the end of readme-vars.yml in the root of this repository, please add your changes there if appropriate -->
<!--- Coding guidelines: -->
<!--- 1. Installed packages in the Dockerfiles should be in alphabetical order -->
<!--- 2. Changes to Dockerfile should be replicated in Dockerfile.armhf and Dockerfile.aarch64 if applicable -->
<!--- 3. Indentation style (tabs vs 4 spaces vs 1 space) should match the rest of the document -->
<!--- 4. Readme is auto generated from readme-vars.yml, make your changes there -->
------------------------------
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-lsio-api/blob/main/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
------------------------------
<!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. -->
## Description:
<!--- Describe your changes in detail -->
## Benefits of this PR and context:
<!--- Please explain why we should accept this PR. If this fixes an outstanding bug, please reference the issue # -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
## Source / References:
<!--- Please include any forum posts/github links relevant to the PR -->

16
.github/workflows/call_issue_pr_tracker.yml vendored Executable file
View File

@ -0,0 +1,16 @@
name: Issue & PR Tracker
on:
issues:
types: [opened,reopened,labeled,unlabeled,closed]
pull_request_target:
types: [opened,reopened,review_requested,review_request_removed,labeled,unlabeled,closed]
pull_request_review:
types: [submitted,edited,dismissed]
jobs:
manage-project:
permissions:
issues: write
uses: linuxserver/github-workflows/.github/workflows/issue-pr-tracker.yml@v1
secrets: inherit

13
.github/workflows/call_issues_cron.yml vendored Executable file
View File

@ -0,0 +1,13 @@
name: Mark stale issues and pull requests
on:
schedule:
- cron: '16 13 * * *'
workflow_dispatch:
jobs:
stale:
permissions:
issues: write
pull-requests: write
uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1
secrets: inherit

25
.github/workflows/external_trigger.yml vendored Normal file
View File

@ -0,0 +1,25 @@
name: External Trigger Main
on:
workflow_dispatch:
jobs:
external-trigger-main:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
- name: External Trigger
if: github.ref == 'refs/heads/main'
env:
SKIP_EXTERNAL_TRIGGER: ${{ vars.SKIP_EXTERNAL_TRIGGER }}
run: |
printf "# External trigger for docker-lsio-api\n\n" >> $GITHUB_STEP_SUMMARY
echo "Type is \`os\`" >> $GITHUB_STEP_SUMMARY
echo "No external release, exiting" >> $GITHUB_STEP_SUMMARY
exit 0
if grep -q "^lsio-api_main_${EXT_RELEASE}" <<< "${SKIP_EXTERNAL_TRIGGER}"; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` matches current external release; skipping trigger." >> $GITHUB_STEP_SUMMARY
exit 0
fi

45
.github/workflows/external_trigger_scheduler.yml vendored Normal file
View File

@ -0,0 +1,45 @@
name: External Trigger Scheduler
on:
schedule:
- cron: '50 * * * *'
workflow_dispatch:
jobs:
external-trigger-scheduler:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
with:
fetch-depth: '0'
- name: External Trigger Scheduler
run: |
printf "# External trigger scheduler for docker-lsio-api\n\n" >> $GITHUB_STEP_SUMMARY
printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
do
if [[ "${br}" == "HEAD" ]]; then
printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
continue
fi
printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-lsio-api/${br}/jenkins-vars.yml)
ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch')
ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type')
if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then
echo "Branch appears to be live and trigger is not os; checking workflow." >> $GITHUB_STEP_SUMMARY
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-lsio-api/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY
curl -iX POST \
-H "Authorization: token ${{ secrets.CR_PAT }}" \
-H "Accept: application/vnd.github.v3+json" \
-d "{\"ref\":\"refs/heads/${br}\"}" \
https://api.github.com/repos/linuxserver/docker-lsio-api/actions/workflows/external_trigger.yml/dispatches
else
echo "Skipping branch due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY
fi
else
echo "Skipping branch due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY
fi
done

13
.github/workflows/greetings.yml vendored Executable file
View File

@ -0,0 +1,13 @@
name: Greetings
on: [pull_request_target, issues]
jobs:
greeting:
runs-on: ubuntu-latest
steps:
- uses: actions/first-interaction@v1
with:
issue-message: 'Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.'
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-lsio-api/blob/main/.github/PULL_REQUEST_TEMPLATE.md)!'
repo-token: ${{ secrets.GITHUB_TOKEN }}

100
.github/workflows/package_trigger_scheduler.yml vendored Normal file
View File

@ -0,0 +1,100 @@
name: Package Trigger Scheduler
on:
schedule:
- cron: '56 6 * * 3'
workflow_dispatch:
jobs:
package-trigger-scheduler:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.1
with:
fetch-depth: '0'
- name: Package Trigger Scheduler
env:
SKIP_PACKAGE_TRIGGER: ${{ vars.SKIP_PACKAGE_TRIGGER }}
run: |
printf "# Package trigger scheduler for docker-lsio-api\n\n" >> $GITHUB_STEP_SUMMARY
printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
do
if [[ "${br}" == "HEAD" ]]; then
printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
continue
fi
printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
JENKINS_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-lsio-api/${br}/jenkins-vars.yml)
if ! curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-lsio-api/${br}/Jenkinsfile >/dev/null 2>&1; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> No Jenkinsfile found. Branch is either deprecated or is an early dev branch." >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
elif [[ "${br}" == $(yq -r '.ls_branch' <<< "${JENKINS_VARS}") ]]; then
echo "Branch appears to be live; checking workflow." >> $GITHUB_STEP_SUMMARY
README_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-lsio-api/${br}/readme-vars.yml)
if [[ $(yq -r '.project_deprecation_status' <<< "${README_VARS}") == "true" ]]; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Branch appears to be deprecated; skipping trigger." >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
elif [[ $(yq -r '.skip_package_check' <<< "${JENKINS_VARS}") == "true" ]]; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Skipping branch ${br} due to \`skip_package_check\` being set in \`jenkins-vars.yml\`." >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
elif grep -q "^lsio-api_${br}" <<< "${SKIP_PACKAGE_TRIGGER}"; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Github organizational variable \`SKIP_PACKAGE_TRIGGER\` contains \`lsio-api_${br}\`; skipping trigger." >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lsio-api/job/${br}/lastBuild/api/json | jq -r '.building' 2>/dev/null) == "true" ]; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> There already seems to be an active build on Jenkins; skipping package trigger for ${br}" >> $GITHUB_STEP_SUMMARY
skipped_branches="${skipped_branches}${br} "
else
echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
echo "> Triggering package trigger for branch ${br}" >> $GITHUB_STEP_SUMMARY
printf "> To disable, add \`lsio-api_%s\` into the Github organizational variable \`SKIP_PACKAGE_TRIGGER\`.\n\n" "${br}" >> $GITHUB_STEP_SUMMARY
triggered_branches="${triggered_branches}${br} "
response=$(curl -iX POST \
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lsio-api/job/${br}/buildWithParameters?PACKAGE_CHECK=true \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
if [[ -z "${response}" ]]; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Jenkins build could not be triggered. Skipping branch."
continue
fi
echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY
echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY
sleep 10
buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
buildurl="${buildurl%$'\r'}"
echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY
echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY
if ! curl -ifX POST \
"${buildurl}submitDescription" \
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
--data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
--data-urlencode "Submit=Submit"; then
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
echo "> Unable to change the Jenkins job description."
fi
sleep 20
fi
else
echo "Skipping branch ${br} due to being detected as dev branch." >> $GITHUB_STEP_SUMMARY
fi
done
if [[ -n "${triggered_branches}" ]] || [[ -n "${skipped_branches}" ]]; then
if [[ -n "${triggered_branches}" ]]; then
NOTIFY_BRANCHES="**Triggered:** ${triggered_branches} \n"
NOTIFY_BUILD_URL="**Build URL:** https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-lsio-api/activity/ \n"
echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****"
fi
if [[ -n "${skipped_branches}" ]]; then
NOTIFY_BRANCHES="${NOTIFY_BRANCHES}**Skipped:** ${skipped_branches} \n"
fi
echo "**** Notifying Discord ****"
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
"description": "**Package Check Build(s) for lsio-api** \n'"${NOTIFY_BRANCHES}"''"${NOTIFY_BUILD_URL}"'"}],
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
fi

12
.github/workflows/permissions.yml vendored Executable file
View File

@ -0,0 +1,12 @@
name: Permission check
on:
pull_request_target:
paths:
- '**/run'
- '**/finish'
- '**/check'
- 'root/migrations/*'
jobs:
permission_check:
uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1

39
.github/workflows/tests.yml vendored Normal file
View File

@ -0,0 +1,39 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Test CI
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install flake8 pytest
if [ -f dev-requirements.txt ]; then pip install -r dev-requirements.txt; fi
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
- name: Test with pytest
run: |
pytest -v

22
.gitignore vendored Normal file
View File

@ -0,0 +1,22 @@
.jenkins-external
venv*
.venv*
__pycache__
.vscode
/output
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
api.db

28
Dockerfile Normal file
View File

@ -0,0 +1,28 @@
FROM ghcr.io/linuxserver/baseimage-alpine:edge
ARG BUILD_DATE
ARG VERSION
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
LABEL maintainer="Quietsy"
COPY root/app/requirements.txt /tmp/requirements.txt
RUN \
echo "**** install packages ****" && \
apk add -U --update --no-cache \
python3 && \
cd /app && \
python3 -m venv /lsiopy && \
pip install -U --no-cache-dir \
pip && \
pip install -U --no-cache-dir -r /tmp/requirements.txt && \
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
echo "**** cleanup ****" && \
rm -rf \
/tmp/* \
$HOME/.cache
COPY root/ /
EXPOSE 8000
VOLUME /config

1136
Jenkinsfile vendored Normal file
View File

File diff suppressed because it is too large Load Diff

674
LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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, either version 3 of the License, or
(at your option) any later version.
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 <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

47
README.md
View File

@ -1 +1,46 @@
# docker-lsio-api
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-lsio-api/blob/main/.github/CONTRIBUTING.md -->
[linuxserverurl]: https://linuxserver.io
[forumurl]: https://discourse.linuxserver.io
[huburl]: https://hub.docker.com/r/linuxserver/lsio-api/
[pipelineurl]: https://github.com/linuxserver/pipeline-triggers
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png?v=4&s=4000)][linuxserverurl]
## Contact information:-
| Type | Address/Details |
| :---: | --- |
| Discord | [Discord](https://discord.gg/linuxserver) |
| Forum | [Linuserver.io forum][forumurl] |
# [linuxserver/lsio-api][huburl]
**This container is not meant for public consumption as it is hard coded to LinuxServer repos**
The purpose of this container expose an API for LinuxServer.
## Usage
The container can be run locally:
```
docker run -d \
--name=lsioapi \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e CI=0 `#optional` \
-e DB_FILE=/config/api.db `#optional` \
-e INVALIDATE_HOURS=24 `#optional` \
-e PAT=token `#optional` \
-p 8000:8000 \
-v /path/to/lsio-api/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/lsio-api:latest
```
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }

26
jenkins-vars.yml Normal file
View File

@ -0,0 +1,26 @@
---
# jenkins variables
project_name: docker-lsio-api
external_type: os
release_type: stable
release_tag: latest
ls_branch: main
repo_vars:
- BUILD_VERSION_ARG = 'OS'
- LS_USER = 'linuxserver'
- LS_REPO = 'docker-lsio-api'
- CONTAINER_NAME = 'lsio-api'
- DOCKERHUB_IMAGE = 'linuxserver/lsio-api'
- DEV_DOCKERHUB_IMAGE = 'lsiodev/lsio-api'
- PR_DOCKERHUB_IMAGE = 'lspipepr/lsio-api'
- DIST_IMAGE = 'alpine'
- MULTIARCH='true'
- CI='true'
- CI_WEB='false'
- CI_PORT='8000'
- CI_SSL='false'
- CI_DELAY='30'
- CI_DOCKERENV='CI=1'
- CI_AUTH=''
- CI_WEBPATH=''

673
package_versions.txt Executable file
View File

@ -0,0 +1,673 @@
NAME VERSION TYPE
Simple Launcher 1.1.0.14 dotnet (+5 duplicates)
adduser 3.137ubuntu1 deb
adwaita-icon-theme 46.0-1 deb
ansi2html 1.8.0 python
anybadge 1.14.0 python
apt 2.7.14build2 deb
apt-utils 2.7.14build2 deb
at-spi2-common 2.52.0-1build1 deb
attrs 25.1.0 python
base-files 13ubuntu10.1 deb
base-passwd 3.6.3build1 deb
bash 5.2.21-2ubuntu4 deb
boto3 1.26.108 python
botocore 1.29.165 python
bsdutils 1:2.39.3-9ubuntu6.2 deb
ca-certificates 20240203 deb
catatonit 0.1.7-1 deb
certifi 2025.1.31 python
charset-normalizer 3.4.1 python
cloud.google.com/go/compute/metadata v0.3.0 go-module
cloud.google.com/go/logging v1.9.0 go-module
cloud.google.com/go/longrunning v0.5.4 go-module
code.cloudfoundry.org/clock v1.1.0 go-module
containerd.io 1.7.25-1 deb
coreutils 9.4-3ubuntu6 deb
cron 3.0pl1-184ubuntu2 deb
cron-daemon-common 3.0pl1-184ubuntu2 deb
curl 8.5.0-2ubuntu10.6 deb
dario.cat/mergo v1.0.0 go-module (+1 duplicate)
dash 0.5.12-6ubuntu5 deb
dbus 1.14.10-4ubuntu4.1 deb
dbus-bin 1.14.10-4ubuntu4.1 deb
dbus-daemon 1.14.10-4ubuntu4.1 deb
dbus-session-bus-common 1.14.10-4ubuntu4.1 deb
dbus-system-bus-common 1.14.10-4ubuntu4.1 deb
dbus-user-session 1.14.10-4ubuntu4.1 deb
dconf-gsettings-backend 0.40.0-4build2 deb
dconf-service 0.40.0-4build2 deb
debconf 1.5.86ubuntu1 deb
debianutils 5.17build1 deb
diffutils 1:3.10-1build1 deb
dirmngr 2.4.4-2ubuntu17 deb
docker 6.0.1 python
docker-ce 5:27.5.1-1~ubuntu.24.04~noble deb
docker-ce-cli 5:27.5.1-1~ubuntu.24.04~noble deb
dpkg 1.22.6ubuntu6.1 deb
e2fsprogs 1.47.0-2.4~exp1ubuntu4.1 deb
findutils 4.9.0-5build1 deb
fontconfig 2.15.0-1.1ubuntu2 deb
fontconfig-config 2.15.0-1.1ubuntu2 deb
fonts-liberation 1:2.1.5-3 deb
gcc-14-base 14.2.0-4ubuntu2~24.04 deb
github.com/Graylog2/go-gelf v0.0.0-20191017102106-1550ee647df0 go-module
github.com/Microsoft/hcsshim v0.11.7 go-module (+1 duplicate)
github.com/Microsoft/hcsshim v0.12.8 go-module
github.com/RackSec/srslog v0.0.0-20180709174129-a4725f04ec91 go-module
github.com/agext/levenshtein v1.2.3 go-module
github.com/anchore/go-struct-converter v0.0.0-20221118182256-c68fdcfa2092 go-module
github.com/armon/circbuf v0.0.0-20190214190532-5111143e8da2 go-module
github.com/armon/go-metrics v0.4.1 go-module
github.com/aws/aws-sdk-go-v2 v1.24.1 go-module
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.5.4 go-module
github.com/aws/aws-sdk-go-v2/config v1.26.6 go-module
github.com/aws/aws-sdk-go-v2/credentials v1.16.16 go-module
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.14.11 go-module
github.com/aws/aws-sdk-go-v2/internal/configsources v1.2.10 go-module
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.5.10 go-module
github.com/aws/aws-sdk-go-v2/internal/ini v1.7.3 go-module
github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.32.0 go-module
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.10.4 go-module
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.10.10 go-module
github.com/aws/aws-sdk-go-v2/service/sso v1.18.7 go-module
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.21.7 go-module
github.com/aws/aws-sdk-go-v2/service/sts v1.26.7 go-module
github.com/aws/smithy-go v1.19.0 go-module
github.com/beorn7/perks v1.0.1 go-module (+1 duplicate)
github.com/bits-and-blooms/bitset v1.13.0 go-module
github.com/blang/semver/v4 v4.0.0 go-module
github.com/cenkalti/backoff/v4 v4.2.1 go-module
github.com/cenkalti/backoff/v4 v4.3.0 go-module
github.com/cespare/xxhash/v2 v2.2.0 go-module
github.com/cespare/xxhash/v2 v2.3.0 go-module
github.com/checkpoint-restore/go-criu/v6 v6.3.0 go-module
github.com/cilium/ebpf v0.12.3 go-module
github.com/cilium/ebpf v0.16.0 go-module
github.com/cilium/ebpf v0.9.1 go-module (+3 duplicates)
github.com/cloudflare/cfssl v1.6.4 go-module
github.com/container-storage-interface/spec v1.5.0 go-module
github.com/containerd/aufs v1.0.0 go-module
github.com/containerd/btrfs/v2 v2.0.0 go-module
github.com/containerd/cgroups v1.1.0 go-module (+1 duplicate)
github.com/containerd/cgroups/v3 v3.0.2 go-module (+3 duplicates)
github.com/containerd/cgroups/v3 v3.0.3 go-module
github.com/containerd/console v1.0.3 go-module (+4 duplicates)
github.com/containerd/console v1.0.4 go-module (+1 duplicate)
github.com/containerd/containerd v1.7.24 go-module
github.com/containerd/containerd v1.7.25 go-module (+4 duplicates)
github.com/containerd/containerd/api v1.7.19 go-module
github.com/containerd/containerd/api v1.8.0 go-module (+4 duplicates)
github.com/containerd/continuity v0.4.4 go-module (+4 duplicates)
github.com/containerd/continuity v0.4.5 go-module
github.com/containerd/errdefs v0.3.0 go-module (+5 duplicates)
github.com/containerd/fifo v1.1.0 go-module (+5 duplicates)
github.com/containerd/go-cni v1.1.10 go-module
github.com/containerd/go-cni v1.1.9 go-module (+1 duplicate)
github.com/containerd/go-runc v1.0.0 go-module (+4 duplicates)
github.com/containerd/go-runc v1.1.0 go-module
github.com/containerd/imgcrypt v1.1.8 go-module
github.com/containerd/log v0.1.0 go-module (+6 duplicates)
github.com/containerd/nri v0.6.1 go-module
github.com/containerd/platforms v0.2.1 go-module (+4 duplicates)
github.com/containerd/stargz-snapshotter/estargz v0.15.1 go-module
github.com/containerd/ttrpc v1.2.5 go-module (+5 duplicates)
github.com/containerd/typeurl v1.0.2 go-module
github.com/containerd/typeurl/v2 v2.1.1 go-module (+4 duplicates)
github.com/containerd/typeurl/v2 v2.2.3 go-module
github.com/containerd/zfs v1.1.0 go-module
github.com/containernetworking/cni v1.1.2 go-module (+1 duplicate)
github.com/containernetworking/cni v1.2.2 go-module
github.com/containernetworking/plugins v1.2.0 go-module
github.com/containernetworking/plugins v1.4.0 go-module
github.com/containers/ocicrypt v1.1.10 go-module
github.com/coreos/go-systemd/v22 v22.5.0 go-module (+5 duplicates)
github.com/cyphar/filepath-securejoin v0.2.4 go-module
github.com/cyphar/filepath-securejoin v0.3.5 go-module
github.com/davecgh/go-spew v1.1.1 go-module (+1 duplicate)
github.com/deckarep/golang-set/v2 v2.3.0 go-module
github.com/dimchansky/utfbom v1.1.1 go-module
github.com/distribution/reference v0.6.0 go-module (+2 duplicates)
github.com/docker/cli/cmd/docker v27.5.1 go-module
github.com/docker/distribution v2.8.3+incompatible go-module
github.com/docker/docker v27.5.1 go-module (+1 duplicate)
github.com/docker/go-connections v0.5.0 go-module
github.com/docker/go-events v0.0.0-20190806004212-e31b211e4f1c go-module (+4 duplicates)
github.com/docker/go-metrics v0.0.1 go-module (+1 duplicate)
github.com/docker/go-units v0.5.0 go-module (+5 duplicates)
github.com/docker/libtrust v0.0.0-20150526203908-9cbd2a1374f4 go-module
github.com/dustin/go-humanize v1.0.0 go-module
github.com/emicklei/go-restful/v3 v3.10.1 go-module
github.com/felixge/httpsnoop v1.0.3 go-module (+1 duplicate)
github.com/felixge/httpsnoop v1.0.4 go-module
github.com/fernet/fernet-go v0.0.0-20211208181803-9f70042a33ee go-module
github.com/fluent/fluent-logger-golang v1.9.0 go-module
github.com/fsnotify/fsnotify v1.6.0 go-module (+1 duplicate)
github.com/go-jose/go-jose/v3 v3.0.3 go-module
github.com/go-logr/logr v1.3.0 go-module (+1 duplicate)
github.com/go-logr/logr v1.4.2 go-module
github.com/go-logr/stdr v1.2.2 go-module (+2 duplicates)
github.com/godbus/dbus/v5 v5.1.0 go-module (+5 duplicates)
github.com/gofrs/flock v0.12.1 go-module
github.com/gogo/protobuf v1.3.2 go-module (+5 duplicates)
github.com/golang-jwt/jwt/v5 v5.2.1 go-module
github.com/golang/gddo v0.0.0-20190904175337-72a348e765d2 go-module
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da go-module
github.com/golang/protobuf v1.5.4 go-module (+5 duplicates)
github.com/google/btree v1.1.2 go-module
github.com/google/certificate-transparency-go v1.1.4 go-module
github.com/google/go-cmp v0.6.0 go-module (+5 duplicates)
github.com/google/gofuzz v1.2.0 go-module
github.com/google/s2a-go v0.1.7 go-module
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 go-module
github.com/google/uuid v1.4.0 go-module (+1 duplicate)
github.com/google/uuid v1.6.0 go-module
github.com/googleapis/enterprise-certificate-proxy v0.3.2 go-module
github.com/googleapis/gax-go/v2 v2.12.0 go-module
github.com/gorilla/mux v1.8.1 go-module
github.com/grpc-ecosystem/go-grpc-middleware v1.3.0 go-module
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 go-module (+1 duplicate)
github.com/grpc-ecosystem/grpc-gateway/v2 v2.16.0 go-module
github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 go-module
github.com/hashicorp/errwrap v1.1.0 go-module (+5 duplicates)
github.com/hashicorp/go-immutable-radix v1.3.1 go-module
github.com/hashicorp/go-immutable-radix/v2 v2.1.0 go-module
github.com/hashicorp/go-memdb v1.3.2 go-module
github.com/hashicorp/go-msgpack v0.5.5 go-module
github.com/hashicorp/go-multierror v1.1.1 go-module (+5 duplicates)
github.com/hashicorp/go-sockaddr v1.0.2 go-module
github.com/hashicorp/golang-lru v0.5.4 go-module
github.com/hashicorp/golang-lru/v2 v2.0.7 go-module
github.com/hashicorp/memberlist v0.4.0 go-module
github.com/hashicorp/serf v0.8.5 go-module
github.com/in-toto/in-toto-golang v0.5.0 go-module
github.com/intel/goresctrl v0.3.0 go-module (+1 duplicate)
github.com/ishidawataru/sctp v0.0.0-20230406120618-7ff4192f6ff2 go-module (+1 duplicate)
github.com/jmoiron/sqlx v1.3.3 go-module
github.com/json-iterator/go v1.1.12 go-module
github.com/klauspost/compress v1.16.7 go-module (+3 duplicates)
github.com/klauspost/compress v1.17.11 go-module
github.com/klauspost/cpuid/v2 v2.0.4 go-module (+1 duplicate)
github.com/matttproud/golang_protobuf_extensions v1.0.4 go-module
github.com/miekg/dns v1.1.57 go-module
github.com/miekg/pkcs11 v1.1.1 go-module
github.com/minio/sha256-simd v1.0.0 go-module (+1 duplicate)
github.com/mistifyio/go-zfs/v3 v3.0.1 go-module (+1 duplicate)
github.com/mitchellh/copystructure v1.2.0 go-module
github.com/mitchellh/hashstructure/v2 v2.0.2 go-module
github.com/mitchellh/reflectwalk v1.0.2 go-module
github.com/moby/buildkit v0.18.2 go-module
github.com/moby/docker-image-spec v1.3.1 go-module
github.com/moby/ipvs v1.1.0 go-module
github.com/moby/locker v1.0.1 go-module (+2 duplicates)
github.com/moby/patternmatcher v0.6.0 go-module
github.com/moby/pubsub v1.0.0 go-module
github.com/moby/spdystream v0.2.0 go-module
github.com/moby/swarmkit/v2 v2.0.0-20241017191044-e8ecf83ee08e go-module
github.com/moby/sys/mount v0.3.4 go-module
github.com/moby/sys/mountinfo v0.6.2 go-module (+4 duplicates)
github.com/moby/sys/mountinfo v0.7.1 go-module
github.com/moby/sys/mountinfo v0.7.2 go-module
github.com/moby/sys/reexec v0.1.0 go-module
github.com/moby/sys/sequential v0.6.0 go-module
github.com/moby/sys/signal v0.7.0 go-module (+1 duplicate)
github.com/moby/sys/signal v0.7.1 go-module
github.com/moby/sys/symlink v0.2.0 go-module
github.com/moby/sys/symlink v0.3.0 go-module
github.com/moby/sys/user v0.3.0 go-module (+5 duplicates)
github.com/moby/sys/userns v0.1.0 go-module (+6 duplicates)
github.com/moby/term v0.5.0 go-module
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd go-module
github.com/modern-go/reflect2 v1.0.2 go-module
github.com/morikuni/aec v1.0.0 go-module
github.com/mrunalp/fileutils v0.5.1 go-module
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 go-module
github.com/opencontainers/go-digest v1.0.0 go-module (+5 duplicates)
github.com/opencontainers/image-spec v1.1.0 go-module (+5 duplicates)
github.com/opencontainers/runc v1.1.14 go-module
github.com/opencontainers/runc v1.2.4-0-g6c52b3f go-module
github.com/opencontainers/runtime-spec v1.1.0 go-module (+4 duplicates)
github.com/opencontainers/runtime-spec v1.2.0 go-module (+1 duplicate)
github.com/opencontainers/runtime-tools v0.9.1-0.20221107090550-2e043c6bd626 go-module (+1 duplicate)
github.com/opencontainers/selinux v1.11.0 go-module (+3 duplicates)
github.com/package-url/packageurl-go v0.1.1-0.20220428063043-89078438f170 go-module
github.com/pelletier/go-toml v1.9.5 go-module (+2 duplicates)
github.com/philhofer/fwd v1.1.2 go-module
github.com/pkg/errors v0.9.1 go-module (+5 duplicates)
github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 go-module
github.com/pmezard/go-difflib v1.0.0 go-module
github.com/prometheus/client_golang v1.14.0 go-module
github.com/prometheus/client_golang v1.20.5 go-module
github.com/prometheus/client_model v0.3.0 go-module
github.com/prometheus/client_model v0.6.1 go-module
github.com/prometheus/common v0.37.0 go-module
github.com/prometheus/common v0.55.0 go-module
github.com/prometheus/procfs v0.15.1 go-module
github.com/prometheus/procfs v0.8.0 go-module
github.com/rootless-containers/rootlesskit/v2 v2.0.2 go-module
github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529 go-module
github.com/seccomp/libseccomp-golang v0.10.0 go-module
github.com/secure-systems-lab/go-securesystemslib v0.4.0 go-module
github.com/shibumi/go-pathspec v1.3.0 go-module
github.com/sirupsen/logrus v1.9.3 go-module (+7 duplicates)
github.com/spdx/tools-golang v0.5.3 go-module
github.com/spf13/cobra v1.8.1 go-module
github.com/spf13/pflag v1.0.5 go-module (+1 duplicate)
github.com/stefanberger/go-pkcs11uri v0.0.0-20230803200340-78284954bff6 go-module
github.com/stretchr/testify v1.9.0 go-module
github.com/syndtr/gocapability v0.0.0-20200815063812-42c35b437635 go-module (+2 duplicates)
github.com/tchap/go-patricia/v2 v2.3.1 go-module
github.com/tinylib/msgp v1.1.8 go-module
github.com/tonistiigi/dchapes-mode v0.0.0-20241001053921-ca0759fec205 go-module
github.com/tonistiigi/fsutil v0.0.0-20241121093142-31cf1f437184 go-module
github.com/tonistiigi/go-actions-cache v0.0.0-20241108014124-394979b8119e go-module
github.com/tonistiigi/go-archvariant v1.0.0 go-module
github.com/tonistiigi/go-csvvalue v0.0.0-20240710180619-ddb21b71c0b4 go-module
github.com/tonistiigi/units v0.0.0-20180711220420-6950e57a87ea go-module
github.com/urfave/cli v1.22.12 go-module (+1 duplicate)
github.com/urfave/cli v1.22.14 go-module
github.com/vbatts/tar-split v0.11.5 go-module
github.com/vishvananda/netlink v1.1.0 go-module
github.com/vishvananda/netlink v1.2.1-beta.2 go-module
github.com/vishvananda/netlink v1.3.1-0.20240922070040-084abd93d350 go-module
github.com/vishvananda/netns v0.0.0-20191106174202-0a2b9b5464df go-module
github.com/vishvananda/netns v0.0.0-20210104183010-2eb08e3e575f go-module
github.com/vishvananda/netns v0.0.4 go-module
github.com/weppos/publicsuffix-go v0.15.1-0.20210511084619-b1f36a2d6c0b go-module
github.com/zmap/zcrypto v0.0.0-20210511125630-18f1e0152cfc go-module
github.com/zmap/zlint/v3 v3.1.0 go-module
gnupg 2.4.4-2ubuntu17 deb
gnupg-l10n 2.4.4-2ubuntu17 deb
gnupg-utils 2.4.4-2ubuntu17 deb
go.etcd.io/bbolt v1.3.10 go-module
go.etcd.io/bbolt v1.3.11 go-module
go.etcd.io/etcd/client/pkg/v3 v3.5.6 go-module
go.etcd.io/etcd/pkg/v3 v3.5.6 go-module
go.etcd.io/etcd/raft/v3 v3.5.6 go-module
go.etcd.io/etcd/server/v3 v3.5.6 go-module
go.mozilla.org/pkcs7 v0.0.0-20200128120323-432b2356ecb1 go-module
go.opencensus.io v0.24.0 go-module
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.46.1 go-module
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.53.0 go-module
go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace v0.53.0 go-module
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.45.0 go-module (+1 duplicate)
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.53.0 go-module
go.opentelemetry.io/otel v1.21.0 go-module (+1 duplicate)
go.opentelemetry.io/otel v1.28.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.28.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp v1.28.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.19.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.28.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.19.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.28.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.19.0 go-module
go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.28.0 go-module
go.opentelemetry.io/otel/metric v1.21.0 go-module (+1 duplicate)
go.opentelemetry.io/otel/metric v1.28.0 go-module
go.opentelemetry.io/otel/sdk v1.21.0 go-module
go.opentelemetry.io/otel/sdk v1.28.0 go-module
go.opentelemetry.io/otel/sdk/metric v1.28.0 go-module
go.opentelemetry.io/otel/trace v1.21.0 go-module (+1 duplicate)
go.opentelemetry.io/otel/trace v1.28.0 go-module
go.opentelemetry.io/proto/otlp v1.0.0 go-module
go.opentelemetry.io/proto/otlp v1.3.1 go-module
go.uber.org/atomic v1.9.0 go-module
go.uber.org/multierr v1.8.0 go-module
go.uber.org/zap v1.21.0 go-module
golang.org/x/crypto v0.27.0 go-module
golang.org/x/crypto v0.31.0 go-module
golang.org/x/exp v0.0.0-20230224173230-c95f2b4c22f2 go-module
golang.org/x/exp v0.0.0-20240909161429-701f63a606c0 go-module
golang.org/x/mod v0.17.0 go-module
golang.org/x/mod v0.21.0 go-module
golang.org/x/net v0.24.0 go-module
golang.org/x/net v0.25.0 go-module (+2 duplicates)
golang.org/x/net v0.29.0 go-module
golang.org/x/oauth2 v0.11.0 go-module
golang.org/x/oauth2 v0.22.0 go-module
golang.org/x/sync v0.10.0 go-module (+4 duplicates)
golang.org/x/sync v0.8.0 go-module
golang.org/x/sys v0.26.0 go-module (+1 duplicate)
golang.org/x/sys v0.28.0 go-module (+5 duplicates)
golang.org/x/term v0.27.0 go-module
golang.org/x/text v0.18.0 go-module
golang.org/x/text v0.21.0 go-module (+2 duplicates)
golang.org/x/time v0.0.0-20220210224613-90d013bbcef8 go-module
golang.org/x/time v0.6.0 go-module
google-chrome-stable 132.0.6834.159-1 deb
google.golang.org/api v0.155.0 go-module
google.golang.org/genproto v0.0.0-20231211222908-989df2bf70f3 go-module (+4 duplicates)
google.golang.org/genproto v0.0.0-20240123012728-ef4313101c80 go-module
google.golang.org/genproto/googleapis/api v0.0.0-20231120223509-83a465c0220f go-module
google.golang.org/genproto/googleapis/api v0.0.0-20240701130421-f6361c86f094 go-module
google.golang.org/genproto/googleapis/rpc v0.0.0-20240401170217-c3f982113cda go-module (+4 duplicates)
google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 go-module
google.golang.org/grpc v1.59.0 go-module (+4 duplicates)
google.golang.org/grpc v1.66.3 go-module
google.golang.org/protobuf v1.33.0 go-module
google.golang.org/protobuf v1.35.1 go-module
google.golang.org/protobuf v1.35.2 go-module (+4 duplicates)
gopkg.in/inf.v0 v0.9.1 go-module (+1 duplicate)
gopkg.in/yaml.v2 v2.4.0 go-module (+1 duplicate)
gopkg.in/yaml.v3 v3.0.1 go-module (+1 duplicate)
gpg 2.4.4-2ubuntu17 deb
gpg-agent 2.4.4-2ubuntu17 deb
gpg-wks-client 2.4.4-2ubuntu17 deb
gpgconf 2.4.4-2ubuntu17 deb
gpgsm 2.4.4-2ubuntu17 deb
gpgv 2.4.4-2ubuntu17 deb
grep 3.11-4build1 deb
gtk-update-icon-cache 3.24.41-4ubuntu1.2 deb
gzip 1.12-1ubuntu3 deb
h11 0.14.0 python
hicolor-icon-theme 0.17-2 deb
hostname 3.23+nmu2ubuntu2 deb
humanity-icon-theme 0.6.16 deb
idna 3.10 python
init-system-helpers 1.66ubuntu1 deb
iptables 1.8.10-3ubuntu2 deb
jinja2 3.1.2 python
jmespath 1.0.1 python
jq 1.7.1-3build1 deb
k8s.io/api v0.26.2 go-module
k8s.io/apimachinery v0.26.2 go-module (+1 duplicate)
k8s.io/apiserver v0.26.2 go-module
k8s.io/client-go v0.26.2 go-module
k8s.io/component-base v0.26.2 go-module
k8s.io/cri-api v0.27.1 go-module
k8s.io/klog/v2 v2.90.1 go-module (+1 duplicate)
k8s.io/utils v0.0.0-20230220204549-a5ecb0141aa5 go-module
keyboxd 2.4.4-2ubuntu17 deb
krb5-locales 1.20.1-6ubuntu2.2 deb
libacl1 2.3.2-1build1.1 deb
libapparmor1 4.0.1really4.0.1-0ubuntu0.24.04.3 deb
libapt-pkg6.0t64 2.7.14build2 deb
libargon2-1 0~20190702+dfsg-4build1 deb
libasound2-data 1.2.11-1build2 deb
libasound2t64 1.2.11-1build2 deb
libassuan0 2.5.6-1build1 deb
libatk-bridge2.0-0t64 2.52.0-1build1 deb
libatk1.0-0t64 2.52.0-1build1 deb
libatspi2.0-0t64 2.52.0-1build1 deb
libattr1 1:2.5.2-1build1.1 deb
libaudit-common 1:3.1.2-2.1build1.1 deb
libaudit1 1:3.1.2-2.1build1.1 deb
libavahi-client3 0.8-13ubuntu6 deb
libavahi-common-data 0.8-13ubuntu6 deb
libavahi-common3 0.8-13ubuntu6 deb
libblkid1 2.39.3-9ubuntu6.2 deb
libbrotli1 1.1.0-2build2 deb
libbsd0 0.12.1-1build1.1 deb
libbz2-1.0 1.0.8-5.1build0.1 deb
libc-bin 2.39-0ubuntu8.3 deb
libc6 2.39-0ubuntu8.3 deb
libcairo-gobject2 1.18.0-3build1 deb
libcairo2 1.18.0-3build1 deb
libcap-ng0 0.8.4-2build2 deb
libcap2 1:2.66-5ubuntu2.1 deb
libcolord2 1.4.7-1build2 deb
libcom-err2 1.47.0-2.4~exp1ubuntu4.1 deb
libcrypt1 1:4.4.36-4build1 deb
libcryptsetup12 2:2.7.0-1ubuntu4.1 deb
libcups2t64 2.4.7-1.2ubuntu7.3 deb
libcurl4t64 8.5.0-2ubuntu10.6 deb
libdatrie1 0.2.13-3build1 deb
libdb5.3t64 5.3.28+dfsg2-7 deb
libdbus-1-3 1.14.10-4ubuntu4.1 deb
libdconf1 0.40.0-4build2 deb
libdebconfclient0 0.271ubuntu3 deb
libdeflate0 1.19-1build1.1 deb
libdevmapper1.02.1 2:1.02.185-3ubuntu3.1 deb
libdrm-amdgpu1 2.4.122-1~ubuntu0.24.04.1 deb
libdrm-common 2.4.122-1~ubuntu0.24.04.1 deb
libdrm-intel1 2.4.122-1~ubuntu0.24.04.1 deb
libdrm-radeon1 2.4.122-1~ubuntu0.24.04.1 deb
libdrm2 2.4.122-1~ubuntu0.24.04.1 deb
libedit2 3.1-20230828-1build1 deb
libelf1t64 0.190-1.1build4.1 deb
libepoxy0 1.5.10-1build1 deb
libexpat1 2.6.1-2ubuntu0.2 deb
libext2fs2t64 1.47.0-2.4~exp1ubuntu4.1 deb
libfdisk1 2.39.3-9ubuntu6.2 deb
libffi8 3.4.6-1build1 deb
libfontconfig1 2.15.0-1.1ubuntu2 deb
libfontenc1 1:1.1.8-1build1 deb
libfreetype6 2.13.2+dfsg-1build3 deb
libfribidi0 1.0.13-3build1 deb
libgbm1 24.2.8-1ubuntu1~24.04.1 deb
libgcc-s1 14.2.0-4ubuntu2~24.04 deb
libgcrypt20 1.10.3-2build1 deb
libgdk-pixbuf-2.0-0 2.42.10+dfsg-3ubuntu3.1 deb
libgdk-pixbuf2.0-common 2.42.10+dfsg-3ubuntu3.1 deb
libgl1 1.7.0-1build1 deb
libgl1-mesa-dri 24.2.8-1ubuntu1~24.04.1 deb
libglapi-mesa 24.2.8-1ubuntu1~24.04.1 deb
libglib2.0-0t64 2.80.0-6ubuntu3.2 deb
libglvnd0 1.7.0-1build1 deb
libglx-mesa0 24.2.8-1ubuntu1~24.04.1 deb
libglx0 1.7.0-1build1 deb
libgmp10 2:6.3.0+dfsg-2ubuntu6.1 deb
libgnutls30t64 3.8.3-1.1ubuntu3.2 deb
libgpg-error0 1.47-3build2.1 deb
libgraphite2-3 1.3.14-2build1 deb
libgssapi-krb5-2 1.20.1-6ubuntu2.2 deb
libgtk-3-0t64 3.24.41-4ubuntu1.2 deb
libgtk-3-common 3.24.41-4ubuntu1.2 deb
libharfbuzz0b 8.3.0-2build2 deb
libhogweed6t64 3.9.1-2.2build1.1 deb
libice6 2:1.0.10-1build3 deb
libicu74 74.2-1ubuntu3.1 deb
libidn2-0 2.3.7-2build1.1 deb
libip4tc2 1.8.10-3ubuntu2 deb
libip6tc2 1.8.10-3ubuntu2 deb
libjbig0 2.1-6.1ubuntu2 deb
libjpeg-turbo8 2.1.5-2ubuntu2 deb
libjpeg8 8c-2ubuntu11 deb
libjq1 1.7.1-3build1 deb
libjson-c5 0.17-1build1 deb
libk5crypto3 1.20.1-6ubuntu2.2 deb
libkeyutils1 1.6.3-3build1 deb
libkmod2 31+20240202-2ubuntu7.1 deb
libkrb5-3 1.20.1-6ubuntu2.2 deb
libkrb5support0 1.20.1-6ubuntu2.2 deb
libksba8 1.6.6-1build1 deb
liblcms2-2 2.14-2build1 deb
libldap-common 2.6.7+dfsg-1~exp1ubuntu8.1 deb
libldap2 2.6.7+dfsg-1~exp1ubuntu8.1 deb
liblerc4 4.0.0+ds-4ubuntu2 deb
libllvm19 1:19.1.1-1ubuntu1~24.04.2 deb
liblz4-1 1.9.4-1build1.1 deb
liblzma5 5.6.1+really5.4.5-1build0.1 deb
libmd0 1.1.0-2build1.1 deb
libmnl0 1.0.5-2build1 deb
libmount1 2.39.3-9ubuntu6.2 deb
libncursesw6 6.4+20240113-1ubuntu2 deb
libnetfilter-conntrack3 1.0.9-6build1 deb
libnettle8t64 3.9.1-2.2build1.1 deb
libnfnetlink0 1.0.2-2build1 deb
libnftnl11 1.2.6-2build1 deb
libnghttp2-14 1.59.0-1ubuntu0.2 deb
libnpth0t64 1.6-3.1build1 deb
libnspr4 2:4.35-1.1build1 deb
libnss3 2:3.98-1build1 deb
libonig5 6.9.9-1build1 deb
libp11-kit0 0.25.3-4ubuntu2.1 deb
libpam-modules 1.5.3-5ubuntu5.1 deb
libpam-modules-bin 1.5.3-5ubuntu5.1 deb
libpam-runtime 1.5.3-5ubuntu5.1 deb
libpam-systemd 255.4-1ubuntu8.5 deb
libpam0g 1.5.3-5ubuntu5.1 deb
libpango-1.0-0 1.52.1+ds-1build1 deb
libpangocairo-1.0-0 1.52.1+ds-1build1 deb
libpangoft2-1.0-0 1.52.1+ds-1build1 deb
libpciaccess0 0.17-3build1 deb
libpcre2-8-0 10.42-4ubuntu2.1 deb
libpixman-1-0 0.42.2-1build1 deb
libpng16-16t64 1.6.43-5build1 deb
libproc2-0 2:4.0.4-4ubuntu3.2 deb
libpsl5t64 0.21.2-1.1build1 deb
libpython3-stdlib 3.12.3-0ubuntu2 deb
libpython3.12-minimal 3.12.3-1ubuntu0.4 deb
libpython3.12-stdlib 3.12.3-1ubuntu0.4 deb
libreadline8t64 8.2-4build1 deb
librtmp1 2.4+20151223.gitfa8646d.1-2build7 deb
libsasl2-2 2.1.28+dfsg1-5ubuntu3.1 deb
libsasl2-modules 2.1.28+dfsg1-5ubuntu3.1 deb
libsasl2-modules-db 2.1.28+dfsg1-5ubuntu3.1 deb
libseccomp2 2.5.5-1ubuntu3.1 deb
libselinux1 3.5-2ubuntu2.1 deb
libsemanage-common 3.5-1build5 deb
libsemanage2 3.5-1build5 deb
libsensors-config 1:3.6.0-9build1 deb
libsensors5 1:3.6.0-9build1 deb
libsepol2 3.5-2build1 deb
libsharpyuv0 1.3.2-0.4build3 deb
libsm6 2:1.2.3-1build3 deb
libsmartcols1 2.39.3-9ubuntu6.2 deb
libsqlite3-0 3.45.1-1ubuntu2.1 deb
libss2 1.47.0-2.4~exp1ubuntu4.1 deb
libssh-4 0.10.6-2build2 deb
libssl3t64 3.0.13-0ubuntu3.4 deb
libstdc++6 14.2.0-4ubuntu2~24.04 deb
libsystemd-shared 255.4-1ubuntu8.5 deb
libsystemd0 255.4-1ubuntu8.5 deb
libtasn1-6 4.19.0-3build1 deb
libthai-data 0.1.29-2build1 deb
libthai0 0.1.29-2build1 deb
libtiff6 4.5.1+git230720-4ubuntu2.2 deb
libtinfo6 6.4+20240113-1ubuntu2 deb
libudev1 255.4-1ubuntu8.5 deb
libunistring5 1.1-2build1.1 deb
libunwind8 1.6.2-3build1 deb
libuuid1 2.39.3-9ubuntu6.2 deb
libvulkan1 1.3.275.0-1build1 deb
libwayland-client0 1.22.0-2.1build1 deb
libwayland-cursor0 1.22.0-2.1build1 deb
libwayland-egl1 1.22.0-2.1build1 deb
libwayland-server0 1.22.0-2.1build1 deb
libwebp7 1.3.2-0.4build3 deb
libx11-6 2:1.8.7-1build1 deb
libx11-data 2:1.8.7-1build1 deb
libx11-xcb1 2:1.8.7-1build1 deb
libxau6 1:1.0.9-1build6 deb
libxaw7 2:1.0.14-1build2 deb
libxcb-dri2-0 1.15-1ubuntu2 deb
libxcb-dri3-0 1.15-1ubuntu2 deb
libxcb-glx0 1.15-1ubuntu2 deb
libxcb-icccm4 0.4.1-1.1build3 deb
libxcb-image0 0.4.0-2build1 deb
libxcb-keysyms1 0.4.0-1build4 deb
libxcb-present0 1.15-1ubuntu2 deb
libxcb-randr0 1.15-1ubuntu2 deb
libxcb-render-util0 0.3.9-1build4 deb
libxcb-render0 1.15-1ubuntu2 deb
libxcb-shape0 1.15-1ubuntu2 deb
libxcb-shm0 1.15-1ubuntu2 deb
libxcb-sync1 1.15-1ubuntu2 deb
libxcb-util1 0.4.0-1build3 deb
libxcb-xfixes0 1.15-1ubuntu2 deb
libxcb-xkb1 1.15-1ubuntu2 deb
libxcb-xv0 1.15-1ubuntu2 deb
libxcb1 1.15-1ubuntu2 deb
libxcomposite1 1:0.4.5-1build3 deb
libxcursor1 1:1.2.1-1build1 deb
libxdamage1 1:1.1.6-1build1 deb
libxdmcp6 1:1.1.3-0ubuntu6 deb
libxext6 2:1.3.4-1build2 deb
libxfixes3 1:6.0.0-2build1 deb
libxfont2 1:2.0.6-1build1 deb
libxi6 2:1.8.1-1build1 deb
libxinerama1 2:1.1.4-3build1 deb
libxkbcommon0 1.6.0-1build1 deb
libxkbfile1 1:1.1.0-1build4 deb
libxml2 2.9.14+dfsg-1.3ubuntu3.1 deb
libxmu6 2:1.1.3-3build2 deb
libxmuu1 2:1.1.3-3build2 deb
libxpm4 1:3.5.17-1build2 deb
libxrandr2 2:1.5.2-2build1 deb
libxrender1 1:0.9.10-1.1build1 deb
libxshmfence1 1.3-1build5 deb
libxt6t64 1:1.2.1-1.2build1 deb
libxtables12 1.8.10-3ubuntu2 deb
libxxf86vm1 1:1.1.4-1build4 deb
libxxhash0 0.8.2-2build1 deb
libzstd1 1.5.5+dfsg2-2build1.1 deb
locales 2.39-0ubuntu8.3 deb
login 1:4.13+dfsg1-4ubuntu3.2 deb
logsave 1.47.0-2.4~exp1ubuntu4.1 deb
markupsafe 3.0.2 python
mawk 1.3.4.20240123-1build1 deb
media-types 10.1.0 deb
mesa-libgallium 24.2.8-1ubuntu1~24.04.1 deb
mount 2.39.3-9ubuntu6.2 deb
ncurses-base 6.4+20240113-1ubuntu2 deb
ncurses-bin 6.4+20240113-1ubuntu2 deb
netbase 6.4 deb
netcat-openbsd 1.226-1ubuntu2 deb
openssl 3.0.13-0ubuntu3.4 deb
outcome 1.3.0.post0 python
packaging 24.2 python
passwd 1:4.13+dfsg1-4ubuntu3.2 deb
perl-base 5.38.2-3.2build2.1 deb
pinentry-curses 1.2.1-3ubuntu5 deb
pip 25.0 python
procps 2:4.0.4-4ubuntu3.2 deb
publicsuffix 20231001.0357-0.1 deb
pysocks 1.7.1 python
python-dateutil 2.9.0.post0 python
python3 3.12.3-0ubuntu2 deb
python3-minimal 3.12.3-0ubuntu2 deb
python3-pip-whl 24.0+dfsg-1ubuntu1.1 deb
python3-setuptools-whl 68.1.2-2ubuntu1.1 deb
python3-venv 3.12.3-0ubuntu2 deb
python3.12 3.12.3-1ubuntu0.4 deb
python3.12-minimal 3.12.3-1ubuntu0.4 deb
python3.12-venv 3.12.3-1ubuntu0.4 deb
pyvirtualdisplay 3.0 python
readline-common 8.2-4build1 deb
requests 2.28.2 python
resenje.org/singleflight v0.4.3 go-module
s3transfer 0.6.2 python
sed 4.9-2build1 deb
selenium 4.8.3 python
sensible-utils 0.0.22 deb
shared-mime-info 2.4-4 deb
sigs.k8s.io/json v0.0.0-20220713155537-f223a00ba0e2 go-module
sigs.k8s.io/structured-merge-diff/v4 v4.2.3 go-module
sigs.k8s.io/yaml v1.3.0 go-module (+1 duplicate)
sigs.k8s.io/yaml v1.4.0 go-module
six 1.17.0 python
sniffio 1.3.1 python
sortedcontainers 2.4.0 python
stdlib go1.22.10 go-module (+5 duplicates)
stdlib go1.22.11 go-module (+2 duplicates)
systemd 255.4-1ubuntu8.5 deb
systemd-dev 255.4-1ubuntu8.5 deb
systemd-sysv 255.4-1ubuntu8.5 deb
sysvinit-utils 3.08-6ubuntu3 deb
tags.cncf.io/container-device-interface v0.7.2 go-module
tags.cncf.io/container-device-interface v0.8.0 go-module
tags.cncf.io/container-device-interface/specs-go v0.7.0 go-module
tags.cncf.io/container-device-interface/specs-go v0.8.0 go-module
tar 1.35+dfsg-3build1 deb
trio 0.28.0 python
trio-websocket 0.11.1 python
tzdata 2024a-3ubuntu1.1 deb
ubuntu-keyring 2023.11.28.1 deb
ubuntu-mono 24.04-0ubuntu1 deb
unminimize 0.2.1 deb
unzip 6.0-28ubuntu4.1 deb
urllib3 1.26.20 python
util-linux 2.39.3-9ubuntu6.2 deb
websocket-client 1.8.0 python
wget 1.21.4-1ubuntu4.1 deb
wsproto 1.2.0 python
x11-common 1:7.7+23ubuntu3 deb
x11-xkb-utils 7.7+8build2 deb
xauth 1:1.1.2-1build1 deb
xdg-utils 1.1.3-4.1ubuntu3 deb
xkb-data 2.41-2ubuntu1.1 deb
xserver-common 2:21.1.12-1ubuntu1.1 deb
xserver-xephyr 2:21.1.12-1ubuntu1.1 deb
xvfb 2:21.1.12-1ubuntu1.1 deb
zlib1g 1:1.3.dfsg-3.1ubuntu2.1 deb

52
readme-vars.yml Normal file
View File

@ -0,0 +1,52 @@
---
# project information
project_name: lsio-api
project_categories: "Internal"
full_custom_readme: |
{% raw -%}
[linuxserverurl]: https://linuxserver.io
[forumurl]: https://discourse.linuxserver.io
[huburl]: https://hub.docker.com/r/linuxserver/lsio-api/
[pipelineurl]: https://github.com/linuxserver/pipeline-triggers
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png?v=4&s=4000)][linuxserverurl]
## Contact information:-
| Type | Address/Details |
| :---: | --- |
| Discord | [Discord](https://discord.gg/linuxserver) |
| Forum | [Linuserver.io forum][forumurl] |
# [linuxserver/lsio-api][huburl]
**This container is not meant for public consumption as it is hard coded to LinuxServer repos**
The purpose of this container expose an API for LinuxServer.
## Usage
The container can be run locally:
```
docker run -d \
--name=lsioapi \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e CI=0 `#optional` \
-e DB_FILE=/config/api.db `#optional` \
-e INVALIDATE_HOURS=24 `#optional` \
-e PAT=token `#optional` \
-p 8000:8000 \
-v /path/to/lsio-api/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/lsio-api:latest
```
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
{%- endraw %}

17
root/app/api.py Normal file
View File

@ -0,0 +1,17 @@
from fastapi import FastAPI
from keyvaluestore import KeyValueStore
from models import ImagesResponse, ImagesData
api = FastAPI(docs_url="/")
@api.get("/health", summary="Get the health status")
async def health():
return "Success"
@api.get("/api/v1/images", response_model=ImagesResponse, summary="Get a list of images")
async def images():
with KeyValueStore() as kv:
return ImagesResponse(status="OK", data=ImagesData.model_validate_json(kv["images"]))
if __name__ == "__main__":
api.run()

30
root/app/keyvaluestore.py Normal file
View File

@ -0,0 +1,30 @@
import os
import sqlite3
DB_FILE = os.environ.get("DB_FILE", "/config/api.db")
class KeyValueStore(dict):
def __init__( self, invalidate_hours=24, readonly=True):
self.invalidate_hours = invalidate_hours
self.readonly = readonly
if not readonly:
self.conn = sqlite3.connect(DB_FILE)
self.conn.execute("CREATE TABLE IF NOT EXISTS kv (key TEXT UNIQUE, value TEXT, updated_at TEXT)")
self.conn.commit()
self.conn.close()
def __enter__(self):
self.conn = sqlite3.connect(DB_FILE, uri=self.readonly)
return self
def __exit__(self, exc_type, exc_val, exc_tb):
if not self.readonly:
self.conn.commit()
self.conn.close()
def __contains__(self, key):
return self.conn.execute(f"SELECT 1 FROM kv WHERE key = '{key}' AND updated_at >= DATETIME('now', '-{self.invalidate_hours} hours')").fetchone() is not None
def __getitem__(self, key):
item = self.conn.execute("SELECT value FROM kv WHERE key = ?", (key,)).fetchone()
return item[0] if item else None
def __setitem__(self, key, value):
self.conn.execute("REPLACE INTO kv (key, value, updated_at) VALUES (?,?, CURRENT_TIMESTAMP)", (key, value))
self.conn.commit()

19
root/app/models.py Normal file
View File

@ -0,0 +1,19 @@
from pydantic import BaseModel
class Image(BaseModel):
name: str
version: str
category: str
stable: bool
deprecated: bool
class Repository(BaseModel):
linuxserver: list[Image]
class ImagesData(BaseModel):
repositories: Repository
class ImagesResponse(BaseModel):
status: str
data: ImagesData

3
root/app/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
fastapi[standard]==0.115.8
PyGithub==2.5.0
PyYAML==6.0.2

70
root/app/updater.py Normal file
View File

@ -0,0 +1,70 @@
from github import Auth
from github import Github
from keyvaluestore import KeyValueStore
from models import Image, Repository, ImagesData
import datetime
import os
import threading
import time
import yaml
CI = os.environ.get("CI", None)
INVALIDATE_HOURS = int(os.environ.get("INVALIDATE_HOURS", "24"))
PAT = os.environ.get("PAT", None)
def get_repos():
auth = Auth.Token(PAT) if PAT else None
gh = Github(auth=auth)
org = gh.get_organization("linuxserver")
repos = org.get_repos()
return [repo for repo in repos if repo.full_name.startswith("linuxserver/docker-")
and not repo.full_name.startswith("linuxserver/docker-baseimage-")
and (repo.description is None or "DEPRECATED" not in repo.description)]
def get_vars(repo, branch):
try:
content = repo.get_contents("readme-vars.yml", ref=branch).decoded_content
return yaml.load(content, Loader=yaml.CLoader)
except:
return None
def get_state():
images = []
repos = get_repos()
for repo in sorted(repos, key=lambda repo: repo.full_name):
readme_vars = get_vars(repo, "master") or get_vars(repo, "main") or get_vars(repo, "develop") or get_vars(repo, "nightly")
if not readme_vars or "'project_deprecation_status': True" in str(readme_vars):
continue
categories = readme_vars.get("project_categories", "")
if "Internal" in categories:
continue
version = "latest" if "development_versions_items" not in readme_vars else readme_vars["development_versions_items"][0]["tag"]
images.append(Image(
name=repo.full_name.replace("linuxserver/docker-", ""),
version=version,
category=categories,
stable=version == "latest",
deprecated=False
))
return ImagesData(repositories=Repository(linuxserver=images)).model_dump_json()
def update_images():
with KeyValueStore(invalidate_hours=INVALIDATE_HOURS, readonly=False) as kv:
if "images" in kv or CI == "1":
print(f"{datetime.datetime.now()} - skipped - already updated")
return
print(f"{datetime.datetime.now()} - updating images")
kv["images"] = get_state()
print(f"{datetime.datetime.now()} - updated images")
class UpdateImages(threading.Thread):
def run(self,*args,**kwargs):
while True:
update_images()
time.sleep(INVALIDATE_HOURS*60*60)
if __name__ == "__main__":
update_images_thread = UpdateImages()
update_images_thread.start()

0
root/etc/s6-overlay/s6-rc.d/svc-api/dependencies.d/init-services Normal file
View File

1
root/etc/s6-overlay/s6-rc.d/svc-api/notification-fd Normal file
View File

@ -0,0 +1 @@
3

5
root/etc/s6-overlay/s6-rc.d/svc-api/run Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/with-contenv bash
# shellcheck shell=bash
exec s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 8000" \
cd /app s6-setuidgid abc fastapi run --workers 4 api.py

1
root/etc/s6-overlay/s6-rc.d/svc-api/type Normal file
View File

@ -0,0 +1 @@
longrun

0
root/etc/s6-overlay/s6-rc.d/svc-updater/dependencies.d/init-services Normal file
View File

1
root/etc/s6-overlay/s6-rc.d/svc-updater/notification-fd Normal file
View File

@ -0,0 +1 @@
3

5
root/etc/s6-overlay/s6-rc.d/svc-updater/run Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/with-contenv bash
# shellcheck shell=bash
exec s6-notifyoncheck -d -n 300 -w 1000 -c "nc -z localhost 8000" \
cd /app s6-setuidgid abc python -u /app/updater.py

1
root/etc/s6-overlay/s6-rc.d/svc-updater/type Normal file
View File

@ -0,0 +1 @@
longrun

0
root/etc/s6-overlay/s6-rc.d/user/contents.d/svc-api Normal file
View File

0
root/etc/s6-overlay/s6-rc.d/user/contents.d/svc-updater Normal file
View File