This repository has been archived by the owner on May 25, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 5
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
0 parents
commit ffb074f
Showing
10 changed files
with
270 additions
and
0 deletions.
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,6 @@ | ||
.git | ||
.gitignore | ||
.github | ||
.gitattributes | ||
READMETEMPLATE.md | ||
README.md |
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,17 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto | ||
|
||
# Custom for Visual Studio | ||
*.cs diff=csharp | ||
|
||
# Standard to msysgit | ||
*.doc diff=astextplain | ||
*.DOC diff=astextplain | ||
*.docx diff=astextplain | ||
*.DOCX diff=astextplain | ||
*.dot diff=astextplain | ||
*.DOT diff=astextplain | ||
*.pdf diff=astextplain | ||
*.PDF diff=astextplain | ||
*.rtf diff=astextplain | ||
*.RTF diff=astextplain |
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,21 @@ | ||
<!--- Provide a general summary of the issue in the Title above --> | ||
|
||
[linuxserverurl]: https://linuxserver.io | ||
[][linuxserverurl] | ||
|
||
|
||
<!--- If you have an issue with the project, please provide us with the following information --> | ||
|
||
<!--- Host OS --> | ||
<!--- Command line users, your run/create command, GUI/Unraid users, a screenshot of your template settings. --> | ||
<!--- Docker log output, docker log <container-name> --> | ||
<!--- Mention if you're using symlinks on any of the volume mounts. --> | ||
|
||
|
||
<!--- If you have a suggestion or fix for the project, please provide us with the following information --> | ||
|
||
<!--- What you think your suggestion brings to the project, or fixes with the project --> | ||
<!--- If it's a fix, would it be better suited as a Pull request to the repo ? --> | ||
|
||
## Thanks, team linuxserver.io | ||
|
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,15 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
|
||
[linuxserverurl]: https://linuxserver.io | ||
[][linuxserverurl] | ||
|
||
|
||
<!--- Before submitting a pull request please check the following --> | ||
|
||
<!--- That you have made a branch in your fork, we'd rather not merge from your master --> | ||
<!--- 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 --> | ||
<!--- --> | ||
|
||
## Thanks, team linuxserver.io | ||
|
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 @@ | ||
# Windows image file caches | ||
Thumbs.db | ||
ehthumbs.db | ||
|
||
# Folder config file | ||
Desktop.ini | ||
|
||
# Recycle Bin used on file shares | ||
$RECYCLE.BIN/ | ||
|
||
# Windows Installer files | ||
*.cab | ||
*.msi | ||
*.msm | ||
*.msp | ||
|
||
# Windows shortcuts | ||
*.lnk | ||
|
||
# ========================= | ||
# Operating System Files | ||
# ========================= | ||
|
||
# OSX | ||
# ========================= | ||
|
||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear on external disk | ||
.Spotlight-V100 | ||
.Trashes | ||
|
||
# Directories potentially created on remote AFP share | ||
.AppleDB | ||
.AppleDesktop | ||
Network Trash Folder | ||
Temporary Items | ||
.apdisk |
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,61 @@ | ||
FROM lsiobase/xenial | ||
MAINTAINER sparklyballs | ||
|
||
# set version label | ||
ARG BUILD_DATE | ||
ARG VERSION | ||
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}" | ||
|
||
# environment settings | ||
ARG DEBIAN_FRONTEND="noninteractive" | ||
ENV NODE_ENV=production | ||
|
||
# build packages variable | ||
ARG BUILD_DEPENDENCIES="\ | ||
apt-transport-https \ | ||
lsb-release" | ||
|
||
# install build packages | ||
RUN \ | ||
apt-get update && \ | ||
apt-get install -y \ | ||
${BUILD_DEPENDENCIES} && \ | ||
|
||
# install runtime packages | ||
curl -sL http://nsolid-deb.nodesource.com/nsolid_setup_2.x | bash - && \ | ||
apt-get install --no-install-recommends -y \ | ||
bzip2 \ | ||
git \ | ||
libfontconfig \ | ||
nsolid-boron \ | ||
python-software-properties && \ | ||
|
||
# install dillinger | ||
mkdir -p \ | ||
/app/dillinger && \ | ||
curl -o \ | ||
/tmp/dillinger.tar.gz -L \ | ||
https://github.com/joemccann/dillinger/archive/master.tar.gz && \ | ||
tar xf \ | ||
/tmp/dillinger.tar.gz -C \ | ||
/app/dillinger --strip-components=1 && \ | ||
cd /app/dillinger && \ | ||
npm install && \ | ||
|
||
# uninstall build packages | ||
apt-get purge -y --auto-remove \ | ||
${BUILD_DEPENDENCIES} && \ | ||
|
||
# cleanup | ||
npm cache clean && \ | ||
rm -rf \ | ||
/tmp/* \ | ||
/var/lib/apt/lists/* \ | ||
/var/tmp/* | ||
|
||
# add local files | ||
COPY root/ / | ||
|
||
# ports and volumes | ||
EXPOSE 8080 | ||
VOLUME /config |
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,15 @@ | ||
[linuxserverurl]: https://linuxserver.io | ||
[forumurl]: https://forum.linuxserver.io | ||
[ircurl]: https://www.linuxserver.io/irc/ | ||
[podcasturl]: https://www.linuxserver.io/podcast/ | ||
|
||
[][linuxserverurl] | ||
|
||
## This is a Container in active development by the [LinuxServer.io][linuxserverurl] team and is not recommended for use by the general public. | ||
|
||
If you want to comment\contribute on this container , are looking for support on any of our other work , or are curious about us in general, check out the following. | ||
|
||
* [forum.linuxserver.io][forumurl] | ||
* [IRC][ircurl] on freenode at `#linuxserver.io` | ||
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! | ||
|
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,81 @@ | ||
[linuxserverurl]: https://linuxserver.io | ||
[forumurl]: https://forum.linuxserver.io | ||
[ircurl]: https://www.linuxserver.io/irc/ | ||
[podcasturl]: https://www.linuxserver.io/podcast/ | ||
[appurl]: www.example.com | ||
[hub]: https://hub.docker.com/r/example/example/ | ||
|
||
[][linuxserverurl] | ||
|
||
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: | ||
* [forum.linuxserver.io][forumurl] | ||
* [IRC][ircurl] on freenode at `#linuxserver.io` | ||
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! | ||
|
||
# <image-name> | ||
|
||
Provide a short, concise description of the application. No more than two SHORT paragraphs. Link to sources where possible and include an image illustrating your point if necessary. Point users to the original applications website, as that's the best place to get support - not here. | ||
|
||
Our Plex container has immaculate docs so follow that if in doubt for layout. | ||
|
||
`IMPORTANT, replace all instances of <image-name> with the correct dockerhub repo (ie linuxserver/plex) and <container-name> information (ie, plex)` | ||
|
||
## Usage | ||
|
||
``` | ||
docker create \ | ||
--name=<container-name> \ | ||
-v <path to data>:/config \ | ||
-e PGID=<gid> -e PUID=<uid> \ | ||
-p 1234:1234 \ | ||
<image-name> | ||
``` | ||
|
||
## Parameters | ||
|
||
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. | ||
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. | ||
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 | ||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.` | ||
|
||
|
||
|
||
* `-p 1234` - the port(s) | ||
* `-v /config` - explain what lives here | ||
* `-e PGID` for GroupID - see below for explanation | ||
* `-e PUID` for UserID - see below for explanation | ||
|
||
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it <container-name> /bin/bash`. | ||
|
||
### User / Group Identifiers | ||
|
||
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™. | ||
|
||
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: | ||
|
||
``` | ||
$ id <dockeruser> | ||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) | ||
``` | ||
|
||
## Setting up the application | ||
|
||
Insert a basic user guide here to get a n00b up and running with the software inside the container. DELETE ME | ||
|
||
|
||
## Info | ||
|
||
* Shell access whilst the container is running: `docker exec -it <container-name> /bin/bash` | ||
* To monitor the logs of the container in realtime: `docker logs -f <container-name>` | ||
|
||
* container version number | ||
|
||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' <container-name>` | ||
|
||
* image version number | ||
|
||
`docker inspect -f '{{ index .Config.Labels "build_version" }}' <image-name>` | ||
|
||
## Versions | ||
|
||
+ **dd.MM.yy:** Initial Release. |
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,5 @@ | ||
#!/usr/bin/with-contenv bash | ||
|
||
chown -R abc:abc \ | ||
/app/dillinger \ | ||
/config |
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,6 @@ | ||
#!/usr/bin/with-contenv bash | ||
|
||
cd /app/dillinger || exit | ||
|
||
exec \ | ||
s6-setuidgid abc npm start |