-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
23 changed files
with
2,775 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
# Contributing to altus | ||
|
||
## 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://discord.gg/YWrKVTn) | ||
|
||
## 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-altus/edit/master/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/images/docker-altus) | ||
|
||
### 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-altus.git | ||
cd docker-altus | ||
docker build \ | ||
--no-cache \ | ||
--pull \ | ||
-t linuxserver/altus:latest . | ||
``` | ||
|
||
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static` | ||
|
||
```bash | ||
docker run --rm --privileged multiarch/qemu-user-static:register --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-altus/tree/master/root), add an entry to the changelog | ||
|
||
```yml | ||
changelogs: | ||
- { date: "DD.MM.YY:", desc: "Added some love to templates" } | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
github: linuxserver | ||
open_collective: linuxserver |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Discord chat support | ||
url: https://discord.gg/YWrKVTn | ||
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/images/docker-altus | ||
about: Documentation - information about all of our containers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# 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: dropdown | ||
attributes: | ||
label: CPU architecture | ||
options: | ||
- x86-64 | ||
validations: | ||
required: true | ||
- 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 linuxserver.io" | ||
label: Container logs | ||
placeholder: | | ||
Output of `docker logs linuxserver.io` | ||
render: bash | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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-altus/blob/master/.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 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: Mark stale issues and pull requests | ||
on: | ||
schedule: | ||
- cron: '50 9 * * *' | ||
workflow_dispatch: | ||
|
||
jobs: | ||
stale: | ||
permissions: | ||
issues: write | ||
pull-requests: write | ||
uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1 | ||
secrets: inherit |
Oops, something went wrong.