Jailman v1.1.0 (#24)
* set branch (+2 squashed commit) Squashed commit: [e322f24] remove placeholder [8647131] palceholder * Code cleanup and (primarily) consolidation (#21) * set branch * Exit 1 on iocage create failure * - Move jailcreate to global function - Remove Jailcreate.sh * Add dataset creation function * - add test script to test new global changes - also create folder in jail with createmount * fix * make test executable * more verbosity, fixing folder creation * moving global dataset create * move jails to new dataset-mount creation function * remove test jail and test branch-ref * Add Nextcloud (#22) * Basic working nextcloud integration * Enable persistent reinstall of Nextcloud * prepare for dev merge * Licence alert * Add external database and integrated jail * small improvements and update script * Add mariadb to dev (#31) * Working MariaDB config * - Set ZFS settings for DB on Nextcloud and MariaDB - Cleanup MariaDB * prepare for dev merge * Niceify Readme (#34) * put content from master into it * Some readme itteration * more niceification * [WIP} Wiki workflow test (#37) introduce automatic wiki generation * Add Bitwarden support (#35) * Nextcloud-Cleanup for v1.1.0 (#40) * Nextcloud cleanup - add db-type sanity check - remove some integrated db checks - Move ssl to /config/ssl - remove integrated databases * slight default tweaking * fix mariadb install bug * QA cycle
This commit is contained in:
parent
b54921f97e
commit
cd5adfd94b
39
.github/workflows/main.yml
vendored
Normal file
39
.github/workflows/main.yml
vendored
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
# This is a basic workflow to help you get started with Actions
|
||||||
|
|
||||||
|
name: Master workflow
|
||||||
|
|
||||||
|
# Controls when the action will run. Triggers the workflow on push or pull request
|
||||||
|
# events but only for the master branch
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ master ]
|
||||||
|
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
create-wiki:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@master
|
||||||
|
- name: rename-readme
|
||||||
|
run: |
|
||||||
|
for pathname in jails/*/README.MD; do ! cp "$pathname" "wiki/$( basename "$( dirname "$pathname" )" ).md"; done
|
||||||
|
for pathname in jails/*/README.md; do ! cp "$pathname" "wiki/$( basename "$( dirname "$pathname" )" ).md"; done
|
||||||
|
for pathname in jails/*/readme.md; do ! cp "$pathname" "wiki/$( basename "$( dirname "$pathname" )" ).md"; done
|
||||||
|
for pathname in jails/*/Readme.md; do ! cp "$pathname" "wiki/$( basename "$( dirname "$pathname" )" ).md"; done
|
||||||
|
shell: bash
|
||||||
|
- name: copy file
|
||||||
|
uses: canastro/copy-file-action@master
|
||||||
|
with:
|
||||||
|
source: "jails/**/*.md"
|
||||||
|
target: "wiki/"
|
||||||
|
- name: Upload wiki to Wiki
|
||||||
|
uses: docker://decathlon/wiki-page-creator-action:latest
|
||||||
|
env:
|
||||||
|
ACTION_MAIL: ornias1993@users.noreply.github.com
|
||||||
|
ACTION_NAME: ornias1993
|
||||||
|
GH_PAT: ${{ secrets.WIKI_GH_PAT }}
|
||||||
|
MD_FOLDER: wiki
|
||||||
|
OWNER: ornias1993
|
||||||
|
REPO_NAME: jailman
|
||||||
|
SKIP_MD: README.md
|
@ -15,10 +15,10 @@ global:
|
|||||||
version: 11.3-RELEASE
|
version: 11.3-RELEASE
|
||||||
# Global pkgs to install in all jails.
|
# Global pkgs to install in all jails.
|
||||||
# Please use standard space delimited pkg install syntax.
|
# Please use standard space delimited pkg install syntax.
|
||||||
pkgs: curl ca_root_nss
|
pkgs: curl ca_root_nss bash
|
||||||
|
|
||||||
|
|
||||||
# Example configuration, showing how to customise network config.
|
# Example configuration, showing how to customise network config.
|
||||||
# Ese the same jailname on both sides of this variable example: example
|
# Ese the same jailname on both sides of this variable example: example
|
||||||
example: example
|
example: example
|
||||||
#interfaces is optional and will be autmatically replace with vnet0:bridge0 if not present
|
#interfaces is optional and will be autmatically replace with vnet0:bridge0 if not present
|
||||||
@ -56,3 +56,39 @@ organizr: organizr
|
|||||||
|
|
||||||
kms: kms
|
kms: kms
|
||||||
pkgs: bash py37-tkinter py37-pip py37-sqlite3 git
|
pkgs: bash py37-tkinter py37-pip py37-sqlite3 git
|
||||||
|
|
||||||
|
|
||||||
|
nextcloud: nextcloud
|
||||||
|
ip4_addr: 192.168.1.99/24
|
||||||
|
gateway: 192.168.1.1
|
||||||
|
time_zone: Europe/Amsterdam
|
||||||
|
host_name: cloud.example.com
|
||||||
|
pkgs: nano sudo redis php73-ctype gnupg php73-dom php73-gd php73-iconv php73-json php73-mbstring php73-posix php73-simplexml php73-xmlreader php73-xmlwriter php73-zip php73-zlib php73-hash php73-xml php73 php73-pecl-redis php73-session php73-wddx php73-xsl php73-filter php73-pecl-APCu php73-curl php73-fileinfo php73-bz2 php73-intl php73-openssl php73-ldap php73-ftp php73-imap php73-exif php73-gmp php73-pecl-memcache php73-pecl-imagick perl5 p5-Locale-gettext help2man texinfo m4 autoconf
|
||||||
|
database: mariadb
|
||||||
|
standalone_cert: 0
|
||||||
|
selfsigned_cert: 0
|
||||||
|
dns_cert: 0
|
||||||
|
no_cert: 1
|
||||||
|
dl_flags: ""
|
||||||
|
dns_settings: ""
|
||||||
|
cert_email: "placeholder@holdplace.org"
|
||||||
|
database: mariadb
|
||||||
|
# db_database:
|
||||||
|
# db_user:
|
||||||
|
# db_password
|
||||||
|
# db_host
|
||||||
|
|
||||||
|
mariadb: mariadb
|
||||||
|
ip4_addr: 192.168.1.98/24
|
||||||
|
gateway: 192.168.1.1
|
||||||
|
pkgs: mariadb104-server git php74-session php74-xml php74-ctype php74-openssl php74-filter php74-gd php74-json php74-mysqli php74-mbstring php74-zlib php74-zip php74-bz2 phpMyAdmin5-php74 php74-pdo_mysql php74-mysqli phpMyAdmin5-php74-5.0.1
|
||||||
|
db_root_password: ReplaceThisWithYourOwnRootPAssword
|
||||||
|
host_name: mariadb.local.example
|
||||||
|
|
||||||
|
bitwarden: bitwarden
|
||||||
|
ip4_addr: 192.168.1.97/24
|
||||||
|
gateway: 192.168.1.1
|
||||||
|
pkgs: sqlite3 nginx git sudo vim-tiny bash node npm python27-2.7.17_1 mariadb104-client
|
||||||
|
db_password: "YourDBPasswordHerePLEASE"
|
||||||
|
type: mariadb
|
||||||
|
admin_token: "PUTYOURADMINTOKENHEREANDREMOVETHIS"
|
||||||
|
@ -1,33 +1,36 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### JailMan is a collection of shell scripts designed to make it easier to install all sorts of iocage Jails on FreeNAS.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[![GitHub last commit](https://img.shields.io/github/last-commit/ornias1993/jailman/dev.svg)](https://github.com/ornias1993/jailman/commits/dev) [![Krihelimeter](http://www.krihelinator.xyz/badge/ornias1993/jailman)](http://www.krihelinator.xyz/repositories/ornias1993/jailman) [![GitHub Release](https://img.shields.io/github/release/ornias1993/jailman.svg)](https://github.com/ornias1993/jailman/releases/latest) [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://github.com/ornias1993/jailman/blob/master/docs/LICENSE.GPLV2) [![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://github.com/ornias1993/jailman/blob/master/docs/LICENSE.BSD2)
|
||||||
|
|
||||||
## Intro
|
## Intro
|
||||||
|
|
||||||
JailMan is a collection of shell scripts designed to make it easier to install iocage Jails on FreeNAS and/or TrueNAS core.
|
There are a lot of great scripts out there to create all sorts of custom jails on FreeNAS. Sadly enough, they all take their own approach to configuration, which lead to a lot of time wasted configuring all sorts of different scripts.
|
||||||
Inspirations for this script are: Docker, FreeNAS plugins, Pentaflake's guide and "freenas-iocage-nextcloud" by danb35.
|
|
||||||
The updater is inspired by the updater designed for ZFS-Compression-Test by Ornias1993.
|
|
||||||
|
|
||||||
The goal of this project is to be able to install, update, reinstall, upgrade and delete most of your services by just running a single command.
|
We do not aim to be some sort of XKCD like "solution to replace all solutions", but aim to simply improve, iterate and integrate the great work others have already put forward.
|
||||||
While doing this we aim for a "docker like" scenario, where the jail is completely disposable and all configuration is saved outside of the jail.
|
|
||||||
|
|
||||||
Example:
|
The goal of this project is to be able to install, update, reinstall, upgrade and delete most of your services by just running a single command using a single config file. While doing this we aim for a "docker like" scenario, where the jail is completely disposable and all configuration is saved outside of the jail.
|
||||||
If something goes wrong with Jackett, you just use:
|
|
||||||
'jailman -r jackett'
|
|
||||||
|
|
||||||
|
## Getting started
|
||||||
## Install
|
### Installing
|
||||||
- Get into FreeNAS using the in-gui console or SSH.
|
- Get into FreeNAS using the in-gui console or SSH.
|
||||||
Run the following commands to install jailman:
|
Run the following commands to install jailman:
|
||||||
- `git clone https://github.com/Ornias1993/jailman.git`
|
- `git clone https://github.com/Ornias1993/jailman.git`
|
||||||
- `cd jailman`
|
- `cd jailman`
|
||||||
- `cp config.yml.example config.yml`
|
- `cp config.yml.example config.yml`
|
||||||
- edit config.yml to reflect your personal settings (optional, see "use")
|
- edit config.yml to reflect your personal settings (optional, see "use")
|
||||||
- Run one of the commands under "use"
|
- Run one of the commands under "How-To Use"
|
||||||
|
|
||||||
Thats all.
|
|
||||||
|
|
||||||
|
|
||||||
## Update
|
### Updating
|
||||||
This script includes an autoupdate feature which checks if changes to the script has been posted to github.
|
This script includes an autoupdate feature which checks if changes to the script has been posted to github.
|
||||||
|
|
||||||
## Use
|
|
||||||
|
## How-To Use
|
||||||
Replace $jailname with the name of the jail you want to install.
|
Replace $jailname with the name of the jail you want to install.
|
||||||
For supported jails, please see this readme or config.yml.example
|
For supported jails, please see this readme or config.yml.example
|
||||||
|
|
||||||
@ -61,19 +64,23 @@ All settings for the applications inside the jails are persistent across reinsta
|
|||||||
config.yml.example includes basic configuration for all jails.
|
config.yml.example includes basic configuration for all jails.
|
||||||
Basic means: The same setup as a FreeNAS plugin would've, DHCP on bridge0.
|
Basic means: The same setup as a FreeNAS plugin would've, DHCP on bridge0.
|
||||||
|
|
||||||
## Currently Supported Services
|
### Currently Supported Services
|
||||||
|
|
||||||
### General
|
#### General
|
||||||
|
|
||||||
- organizr
|
- organizr
|
||||||
- py-kms
|
- py-kms
|
||||||
|
- nextcloud
|
||||||
|
|
||||||
### Downloads
|
#### Backend
|
||||||
|
- mariadb
|
||||||
|
|
||||||
|
#### Downloads
|
||||||
|
|
||||||
- transmission
|
- transmission
|
||||||
- jackett
|
- jackett
|
||||||
|
|
||||||
### Media
|
#### Media
|
||||||
|
|
||||||
- plex
|
- plex
|
||||||
- tautulli
|
- tautulli
|
||||||
@ -81,21 +88,37 @@ Basic means: The same setup as a FreeNAS plugin would've, DHCP on bridge0.
|
|||||||
- radarr
|
- radarr
|
||||||
- lidarr
|
- lidarr
|
||||||
|
|
||||||
## References
|
## Get involved
|
||||||
|
|
||||||
- Pentaflake's guide:
|
### Preparing your own copy of JailMan
|
||||||
https://www.ixsystems.com/community/resources/fn11-3-iocage-jails-plex-tautulli-sonarr-radarr-lidarr-jackett-transmission-organizr.58/
|
Getting involved with JailMan and creating your own Jails, is really simple although experience with Bash, BSD and iocage is highly recommended.
|
||||||
|
|
||||||
- "freenas-iocage-nextcloud" by danb35:
|
- Fork the JailMan Repository and clone your own fork to disk.
|
||||||
https://github.com/danb35/freenas-iocage-nextcloud
|
- Create a new branch, starting from the dev branch (with all current development changes)
|
||||||
|
- Open Jailman.sh and `BRANCH="dev"`into your own branch.
|
||||||
|
|
||||||
- "ZFS-Compression-Test" by Ornias1993:
|
### Making changes
|
||||||
https://github.com/Ornias1993/zfs-compression-test
|
To add a jail, you need 4 things:
|
||||||
|
|
||||||
- "py-kms" by SystemRage and others:
|
- A jailfolder under jails/
|
||||||
https://github.com/SystemRage/py-kms
|
- an install script in the jail folder, named `install.sh`
|
||||||
|
- an update script in the jail folder, named `update.sh`
|
||||||
|
- an entry in `config.yml` with the name of your jail
|
||||||
|
|
||||||
|
All jails created by JailMan start with their own persistant data folder in a seperate dataset, mounted under `/config`.
|
||||||
|
You can safely use this, or create additional datasets and mount those.
|
||||||
|
|
||||||
|
To make your experience making changes to Jailman as easy as possible, we already made some convenience functions in global.sh, those are available to your jail install and update scripts from the start!
|
||||||
|
|
||||||
### LICENCE
|
But above all: Have fun building it!
|
||||||
|
|
||||||
|
## LICENCE
|
||||||
This work is dual licenced under GPLv2 and BSD-2 clause
|
This work is dual licenced under GPLv2 and BSD-2 clause
|
||||||
|
|
||||||
|
### Sub-Licences
|
||||||
|
Some sub-modules available under "jails" might be licenced under a different licence.
|
||||||
|
Please be aware of this and take note of any LICENCE files signaling a differently licenced sub-module.
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
![built-with-resentment](http://forthebadge.com/images/badges/built-with-resentment.svg) ![contains-technical-debt](http://forthebadge.com/images/badges/contains-technical-debt.svg)
|
||||||
|
86
global.sh
86
global.sh
@ -37,3 +37,89 @@ else
|
|||||||
echo "script up-to-date"
|
echo "script up-to-date"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
jailcreate() {
|
||||||
|
echo "Checking config..."
|
||||||
|
jailname="${1}"
|
||||||
|
jailpkgs="${1}_pkgs"
|
||||||
|
jailinterfaces="${1}_interfaces"
|
||||||
|
jailip4="${1}_ip4_addr"
|
||||||
|
jailgateway="${1}_gateway"
|
||||||
|
jaildhcp="${1}_dhcp"
|
||||||
|
setdhcp=${!jaildhcp}
|
||||||
|
|
||||||
|
if [ -z "${!jailinterfaces}" ]; then
|
||||||
|
jailinterfaces="vnet0:bridge0"
|
||||||
|
else
|
||||||
|
jailinterfaces=${!jailinterfaces}
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${setdhcp}" ] && [ -z "${!jailip4}" ] && [ -z "${!jailgateway}" ]; then
|
||||||
|
echo 'no network settings specified in config.yml, defaulting to dhcp="on"'
|
||||||
|
setdhcp="on"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${!jailname}" ]; then
|
||||||
|
echo "ERROR, jail not defined in config.yml"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
echo "Creating jail for $1"
|
||||||
|
pkgs="$(sed 's/[^[:space:]]\{1,\}/"&"/g;s/ /,/g' <<<"${global_jails_pkgs} ${!jailpkgs}")"
|
||||||
|
echo '{"pkgs":['${pkgs}']}' > /tmp/pkg.json
|
||||||
|
if [ "${setdhcp}" == "on" ]
|
||||||
|
then
|
||||||
|
if ! iocage create -n "${1}" -p /tmp/pkg.json -r ${global_jails_version} interfaces="${jailinterfaces}" dhcp="on" vnet="on" allow_raw_sockets="1" boot="on"
|
||||||
|
then
|
||||||
|
echo "Failed to create jail"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
if ! iocage create -n "${1}" -p /tmp/pkg.json -r ${global_jails_version} interfaces="${jailinterfaces}" ip4_addr="vnet0|${!jailip4}" defaultrouter="${!jailgateway}" vnet="on" allow_raw_sockets="1" boot="on"
|
||||||
|
then
|
||||||
|
echo "Failed to create jail"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
fi
|
||||||
|
|
||||||
|
rm /tmp/pkg.json
|
||||||
|
echo "creating jail config directory"
|
||||||
|
|
||||||
|
createmount $1 ${global_dataset_config}
|
||||||
|
createmount $1 ${global_dataset_config}/$1 /config
|
||||||
|
|
||||||
|
echo "Jail creation completed for $1"
|
||||||
|
fi
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
# $1 = jail name
|
||||||
|
# $2 = Dataset
|
||||||
|
# $3 = Target mountpoint
|
||||||
|
# $4 = fstab prefernces
|
||||||
|
createmount() {
|
||||||
|
if [ -z "$2" ] ; then
|
||||||
|
echo "ERROR: No Dataset specified to create and/or mount"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
if [ ! -d "/mnt/$2" ]; then
|
||||||
|
echo "Dataset does not exist... Creating... $2"
|
||||||
|
zfs create $2
|
||||||
|
else
|
||||||
|
echo "Dataset already exists, skipping creation of $2"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$1" ] && [ -n "$3" ]; then
|
||||||
|
iocage exec $1 mkdir -p $3
|
||||||
|
if [ -n "$4" ]; then
|
||||||
|
iocage fstab -a $1 /mnt/$2 $3 $4
|
||||||
|
else
|
||||||
|
iocage fstab -a $1 /mnt/$2 $3 nullfs rw 0 0
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "No Jail Name or Mount target specified, not mounting dataset"
|
||||||
|
fi
|
||||||
|
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
export -f createmount
|
||||||
|
@ -1,53 +0,0 @@
|
|||||||
#!/usr/local/bin/bash
|
|
||||||
|
|
||||||
echo "Checking config..."
|
|
||||||
jailname="${1}"
|
|
||||||
jailpkgs="${1}_pkgs"
|
|
||||||
jailinterfaces="${1}_interfaces"
|
|
||||||
jailip4="${1}_ip4_addr"
|
|
||||||
jailgateway="${1}_gateway"
|
|
||||||
jaildhcp="${1}_dhcp"
|
|
||||||
setdhcp=${!jaildhcp}
|
|
||||||
|
|
||||||
if [ -z "${!jailinterfaces}" ]; then
|
|
||||||
jailinterfaces="vnet0:bridge0"
|
|
||||||
else
|
|
||||||
jailinterfaces=${!jailinterfaces}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "${setdhcp}" ] && [ -z "${!jailip4}" ] && [ -z "${!jailgateway}" ]; then
|
|
||||||
echo 'no network settings specified in config.yml, defaulting to dhcp="on"'
|
|
||||||
setdhcp="on"
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ -z "${!jailname}" ]; then
|
|
||||||
echo "ERROR, jail not defined in config.yml"
|
|
||||||
exit 1
|
|
||||||
else
|
|
||||||
echo "Creating jail for $1"
|
|
||||||
pkgs="$(sed 's/[^[:space:]]\{1,\}/"&"/g;s/ /,/g' <<<"${!jailpkgs} ${global_jails_pkgs}")"
|
|
||||||
echo '{"pkgs":['${pkgs}']}' > /tmp/pkg.json
|
|
||||||
if [ "${setdhcp}" == "on" ]
|
|
||||||
then
|
|
||||||
iocage create -n "${1}" -p /tmp/pkg.json -r ${global_jails_version} interfaces="${jailinterfaces}" dhcp="on" vnet="on" allow_raw_sockets="1" boot="on"
|
|
||||||
else
|
|
||||||
iocage create -n "${1}" -p /tmp/pkg.json -r ${global_jails_version} interfaces="${jailinterfaces}" ip4_addr="vnet0|${!jailip4}" defaultrouter="${!jailgateway}" vnet="on" allow_raw_sockets="1" boot="on"
|
|
||||||
fi
|
|
||||||
|
|
||||||
rm /tmp/pkg.json
|
|
||||||
echo "creating jail config directory"
|
|
||||||
iocage exec $1 mkdir -p /config
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_config}" ]; then
|
|
||||||
echo "Config root dataset does not exist... Creating... ${global_dataset_config}"
|
|
||||||
zfs create ${global_dataset_config}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_config}/$1" ]; then
|
|
||||||
echo "Config dataset does not exist... Creating... ${global_dataset_config}/$1"
|
|
||||||
zfs create ${global_dataset_config}/$1
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a $1 /mnt/${global_dataset_config}/$1 /config nullfs rw 0 0
|
|
||||||
echo "Jail creation completed for $1"
|
|
||||||
fi
|
|
10
jailman.sh
10
jailman.sh
@ -15,7 +15,7 @@ if ! [ $(id -u) = 0 ]; then
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
# Auto Update
|
# Auto Update
|
||||||
BRANCH="master"
|
BRANCH="dev"
|
||||||
gitupdate ${BRANCH}
|
gitupdate ${BRANCH}
|
||||||
|
|
||||||
# If no option is given, point to the help menu
|
# If no option is given, point to the help menu
|
||||||
@ -110,7 +110,7 @@ else
|
|||||||
if [ -f "${SCRIPT_DIR}/jails/$jail/install.sh" ]
|
if [ -f "${SCRIPT_DIR}/jails/$jail/install.sh" ]
|
||||||
then
|
then
|
||||||
echo "Installing $jail"
|
echo "Installing $jail"
|
||||||
${SCRIPT_DIR}/jailcreate.sh $jail && ${SCRIPT_DIR}/jails/$jail/install.sh
|
jailcreate $jail && ${SCRIPT_DIR}/jails/$jail/install.sh
|
||||||
else
|
else
|
||||||
echo "Missing install script for $jail in ${SCRIPT_DIR}/jails/$jail/install.sh"
|
echo "Missing install script for $jail in ${SCRIPT_DIR}/jails/$jail/install.sh"
|
||||||
fi
|
fi
|
||||||
@ -127,7 +127,7 @@ else
|
|||||||
if [ -f "${SCRIPT_DIR}/jails/$jail/install.sh" ]
|
if [ -f "${SCRIPT_DIR}/jails/$jail/install.sh" ]
|
||||||
then
|
then
|
||||||
echo "Reinstalling $jail"
|
echo "Reinstalling $jail"
|
||||||
iocage destroy -f $jail && ${SCRIPT_DIR}/jailcreate.sh $jail && ${SCRIPT_DIR}/jails/$jail/install.sh
|
iocage destroy -f $jail && jailcreate $jail && ${SCRIPT_DIR}/jails/$jail/install.sh
|
||||||
else
|
else
|
||||||
echo "Missing install script for $jail in ${SCRIPT_DIR}/jails/$jail/update.sh"
|
echo "Missing install script for $jail in ${SCRIPT_DIR}/jails/$jail/update.sh"
|
||||||
fi
|
fi
|
||||||
@ -145,8 +145,10 @@ else
|
|||||||
if [ -f "${SCRIPT_DIR}/jails/$jail/update.sh" ]
|
if [ -f "${SCRIPT_DIR}/jails/$jail/update.sh" ]
|
||||||
then
|
then
|
||||||
echo "Updating $jail"
|
echo "Updating $jail"
|
||||||
iocage update $jail && iocage exec $jail "pkg update && pkg upgrade -y" && ${SCRIPT_DIR}/jails/$jail/update.sh
|
iocage update $jail
|
||||||
|
iocage exec $jail "pkg update && pkg upgrade -y" && ${SCRIPT_DIR}/jails/$jail/update.sh
|
||||||
iocage restart $jail
|
iocage restart $jail
|
||||||
|
iocage start $jail
|
||||||
else
|
else
|
||||||
echo "Missing update script for $jail in ${SCRIPT_DIR}/jails/$jail/update.sh"
|
echo "Missing update script for $jail in ${SCRIPT_DIR}/jails/$jail/update.sh"
|
||||||
fi
|
fi
|
||||||
|
17
jails/bitwarden/includes/bitwarden.rc
Executable file
17
jails/bitwarden/includes/bitwarden.rc
Executable file
@ -0,0 +1,17 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
# PROVIDE: bitwarden
|
||||||
|
# REQUIRE: LOGIN DAEMON NETWORKING FILESYSTEMS
|
||||||
|
# KEYWORD: jail rust
|
||||||
|
|
||||||
|
. /etc/rc.subr
|
||||||
|
|
||||||
|
name="bitwarden"
|
||||||
|
|
||||||
|
|
||||||
|
rcvar=${name}_enable
|
||||||
|
pidfile="/var/run/${name}.pid"
|
||||||
|
command="/usr/sbin/daemon"
|
||||||
|
command_args="-u bitwarden -c -f -P ${pidfile} -r /usr/local/share/bitwarden/bin/bitwarden_rs"
|
||||||
|
load_rc_config $name
|
||||||
|
run_rc_command "$1"
|
13
jails/bitwarden/includes/bitwarden.rc.conf
Executable file
13
jails/bitwarden/includes/bitwarden.rc.conf
Executable file
@ -0,0 +1,13 @@
|
|||||||
|
export DATA_FOLDER="/config"
|
||||||
|
export ENABLE_DB_WAL="false"
|
||||||
|
export ROCKET_TLS="{certs="/config/ssl/bitwarden-ssl.crt",key="/config/ssl/bitwarden-ssl.key"}"
|
||||||
|
export LOG_FILE="/config/bitwarden.log"
|
||||||
|
export WEB_VAULT_FOLDER="/usr/local/share/bitwarden/web-vault"
|
||||||
|
export LOG_LEVEL="trace"
|
||||||
|
export WEBSOCKET_ENABLED="true"
|
||||||
|
export DISABLE_ICON_DOWNLOAD=false
|
||||||
|
export ICON_CACHE_FOLDER="/config/icon_cache"
|
||||||
|
export ICON_CACHE_TTL=2592000
|
||||||
|
export ICON_CACHE_NEGTTL=259200
|
||||||
|
export ROCKET_WORKERS=20
|
||||||
|
export ROCKET_PORT=8000
|
86
jails/bitwarden/install.sh
Executable file
86
jails/bitwarden/install.sh
Executable file
@ -0,0 +1,86 @@
|
|||||||
|
#!/usr/local/bin/bash
|
||||||
|
# This file contains the install script for bitwarden
|
||||||
|
|
||||||
|
# Initialise defaults
|
||||||
|
JAIL_NAME="bitwarden"
|
||||||
|
DB_DATABASE=${JAIL_NAME}
|
||||||
|
DB_USER=${JAIL_NAME}
|
||||||
|
INSTALL_TYPE=${bitwarden_type}
|
||||||
|
DB_HOST="$(sed 's|\(.*\)/.*|\1|' <<<"${mariadb_ip4_addr}"):3306"
|
||||||
|
DB_PASSWORD="${bitwarden_db_password}"
|
||||||
|
DB_STRING="mysql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}/${DB_DATABASE}"
|
||||||
|
ADMIN_TOKEN=${bitwarden_admin_token}
|
||||||
|
|
||||||
|
if [ -z "${ADMIN_TOKEN}" ]; then
|
||||||
|
ADMIN_TOKEN=$(openssl rand -base64 16)
|
||||||
|
fi
|
||||||
|
|
||||||
|
# install latest rust version, pkg version is outdated and can't build bitwarden_rs
|
||||||
|
iocage exec ${JAIL_NAME} "curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y"
|
||||||
|
|
||||||
|
# Install Bitwarden_rs
|
||||||
|
iocage exec ${JAIL_NAME} mkdir -p /usr/local/share/bitwarden/src
|
||||||
|
iocage exec ${JAIL_NAME} git clone https://github.com/dani-garcia/bitwarden_rs/ /usr/local/share/bitwarden/src
|
||||||
|
TAG=$(iocage exec ${JAIL_NAME} "git -C /usr/local/share/bitwarden/src tag --sort=v:refname | tail -n1")
|
||||||
|
iocage exec ${JAIL_NAME} "git -C /usr/local/share/bitwarden/src checkout ${TAG}"
|
||||||
|
#TODO replace with: cargo build --features mysql --release
|
||||||
|
if [ "${INSTALL_TYPE}" == "mariadb" ]; then
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features mysql --release"
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features mysql"
|
||||||
|
else
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features sqlite --release"
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features sqlite-bundled"
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} cp -r /usr/local/share/bitwarden/src/target/release /usr/local/share/bitwarden/bin
|
||||||
|
|
||||||
|
# Download and install webvault
|
||||||
|
WEB_RELEASE_URL=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/dani-garcia/bw_web_builds/releases/latest)
|
||||||
|
WEB_TAG="${WEB_RELEASE_URL##*/}"
|
||||||
|
iocage exec ${JAIL_NAME} "fetch http://github.com/dani-garcia/bw_web_builds/releases/download/$WEB_TAG/bw_web_$WEB_TAG.tar.gz -o /usr/local/share/bitwarden"
|
||||||
|
iocage exec ${JAIL_NAME} "tar -xzvf /usr/local/share/bitwarden/bw_web_$WEB_TAG.tar.gz -C /usr/local/share/bitwarden/"
|
||||||
|
iocage exec ${JAIL_NAME} rm /usr/local/share/bitwarden/bw_web_$WEB_TAG.tar.gz
|
||||||
|
|
||||||
|
if [ -f "/mnt/${global_dataset_config}/${JAIL_NAME}/ssl/bitwarden-ssl.crt" ]; then
|
||||||
|
echo "certificate exist... Skipping cert generation"
|
||||||
|
else
|
||||||
|
"No ssl certificate present, generating self signed certificate"
|
||||||
|
if [ ! -d "/mnt/${global_dataset_config}/${JAIL_NAME}/ssl" ]; then
|
||||||
|
echo "cert folder not existing... creating..."
|
||||||
|
iocage exec ${JAIL_NAME} mkdir /config/ssl
|
||||||
|
fi
|
||||||
|
openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=localhost" -keyout /mnt/${global_dataset_config}/${JAIL_NAME}/ssl/bitwarden-ssl.key -out /mnt/${global_dataset_config}/${JAIL_NAME}/ssl/bitwarden-ssl.crt
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -f "/mnt/${global_dataset_config}/${JAIL_NAME}/bitwarden.log" ]; then
|
||||||
|
echo "Reinstall of Bitwarden detected... using existing config and database"
|
||||||
|
elif [ "${INSTALL_TYPE}" == "mariadb" ]; then
|
||||||
|
echo "No config detected, doing clean install, utilizing the Mariadb database ${DB_HOST}"
|
||||||
|
iocage exec "mariadb" mysql -u root -e "CREATE DATABASE ${DB_DATABASE};"
|
||||||
|
iocage exec "mariadb" mysql -u root -e "GRANT ALL ON ${DB_DATABASE}.* TO ${DB_USER}@${JAIL_IP} IDENTIFIED BY '${DB_PASSWORD}';"
|
||||||
|
iocage exec "mariadb" mysqladmin reload
|
||||||
|
else
|
||||||
|
echo "No config detected, doing clean install."
|
||||||
|
fi
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} "pw user add bitwarden -c bitwarden -u 725 -d /nonexistent -s /usr/bin/nologin"
|
||||||
|
iocage exec ${JAIL_NAME} chown -R bitwarden:bitwarden /usr/local/share/bitwarden /config
|
||||||
|
iocage exec ${JAIL_NAME} mkdir /usr/local/etc/rc.d /usr/local/etc/rc.conf.d
|
||||||
|
cp ${SCRIPT_DIR}/jails/${JAIL_NAME}/includes/bitwarden.rc /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.d/bitwarden
|
||||||
|
cp ${SCRIPT_DIR}/jails/${JAIL_NAME}/includes/bitwarden.rc.conf /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.conf.d/bitwarden
|
||||||
|
echo 'export DATABASE_URL="'${DB_STRING}'"' >> /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.conf.d/bitwarden
|
||||||
|
echo 'export ADMIN_TOKEN="'${ADMIN_TOKEN}'"' >> /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.conf.d/bitwarden
|
||||||
|
|
||||||
|
if [ "${ADMIN_TOKEN}" == "NONE" ]; then
|
||||||
|
echo "Admin_token set to NONE, disabling admin portal"
|
||||||
|
else
|
||||||
|
echo "Admin_token set and admin portal enabled"
|
||||||
|
iocage exec "${JAIL_NAME}" echo "${DB_NAME} Admin Token is ${ADMIN_TOKEN}" > /root/${JAIL_NAME}_admin_token.txt
|
||||||
|
fi
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} chmod u+x /usr/local/etc/rc.d/bitwarden
|
||||||
|
iocage exec ${JAIL_NAME} sysrc "bitwarden_enable=YES"
|
||||||
|
iocage exec ${JAIL_NAME} service bitwarden restart
|
||||||
|
echo "Jail ${JAIL_NAME} finished Bitwarden install."
|
||||||
|
echo "Admin Token is ${ADMIN_TOKEN}"
|
66
jails/bitwarden/readme.md
Executable file
66
jails/bitwarden/readme.md
Executable file
@ -0,0 +1,66 @@
|
|||||||
|
# Original README from the Bitwarden_rs github:
|
||||||
|
|
||||||
|
https://github.com/dani-garcia/bitwarden_rs
|
||||||
|
|
||||||
|
# Bitwarden_RS
|
||||||
|
### This is a Bitwarden server API implementation written in Rust compatible with [upstream Bitwarden clients](https://bitwarden.com/#download)*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[![Travis Build Status](https://travis-ci.org/dani-garcia/bitwarden_rs.svg?branch=master)](https://travis-ci.org/dani-garcia/bitwarden_rs)
|
||||||
|
[![Docker Pulls](https://img.shields.io/docker/pulls/bitwardenrs/server.svg)](https://hub.docker.com/r/bitwardenrs/server)
|
||||||
|
[![Dependency Status](https://deps.rs/repo/github/dani-garcia/bitwarden_rs/status.svg)](https://deps.rs/repo/github/dani-garcia/bitwarden_rs)
|
||||||
|
[![GitHub Release](https://img.shields.io/github/release/dani-garcia/bitwarden_rs.svg)](https://github.com/dani-garcia/bitwarden_rs/releases/latest)
|
||||||
|
[![GPL-3.0 Licensed](https://img.shields.io/github/license/dani-garcia/bitwarden_rs.svg)](https://github.com/dani-garcia/bitwarden_rs/blob/master/LICENSE.txt)
|
||||||
|
[![Matrix Chat](https://img.shields.io/matrix/bitwarden_rs:matrix.org.svg?logo=matrix)](https://matrix.to/#/#bitwarden_rs:matrix.org)
|
||||||
|
|
||||||
|
Image is based on [Rust implementation of Bitwarden API](https://github.com/dani-garcia/bitwarden_rs).
|
||||||
|
|
||||||
|
**This project is not associated with the [Bitwarden](https://bitwarden.com/) project nor 8bit Solutions LLC.**
|
||||||
|
|
||||||
|
#### ⚠️**IMPORTANT**⚠️: When using this server, please report any bugs or suggestions to us directly (look at the bottom of this page for ways to get in touch), regardless of whatever clients you are using (mobile, desktop, browser...). DO NOT use the official support channels.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Basically full implementation of Bitwarden API is provided including:
|
||||||
|
|
||||||
|
* Single user functionality
|
||||||
|
* Organizations support
|
||||||
|
* Attachments
|
||||||
|
* Vault API support
|
||||||
|
* Serving the static files for Vault interface
|
||||||
|
* Website icons API
|
||||||
|
* Authenticator and U2F support
|
||||||
|
* YubiKey and Duo support
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
Pull the docker image and mount a volume from the host for persistent storage:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker pull bitwardenrs/server:latest
|
||||||
|
docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 bitwardenrs/server:latest
|
||||||
|
```
|
||||||
|
This will preserve any persistent data under /bw-data/, you can adapt the path to whatever suits you.
|
||||||
|
|
||||||
|
**IMPORTANT**: Some web browsers, like Chrome, disallow the use of Web Crypto APIs in insecure contexts. In this case, you might get an error like `Cannot read property 'importKey'`. To solve this problem, you need to access the web vault from HTTPS.
|
||||||
|
|
||||||
|
This can be configured in [bitwarden_rs directly](https://github.com/dani-garcia/bitwarden_rs/wiki/Enabling-HTTPS) or using a third-party reverse proxy ([some examples](https://github.com/dani-garcia/bitwarden_rs/wiki/Proxy-examples)).
|
||||||
|
|
||||||
|
If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy (see examples linked above).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
See the [bitwarden_rs wiki](https://github.com/dani-garcia/bitwarden_rs/wiki) for more information on how to configure and run the bitwarden_rs server.
|
||||||
|
|
||||||
|
## Get in touch
|
||||||
|
To ask a question, offer suggestions or new features or to get help configuring or installing the software, please [use the forum](https://bitwardenrs.discourse.group/).
|
||||||
|
|
||||||
|
If you spot any bugs or crashes with bitwarden_rs itself, please [create an issue](https://github.com/dani-garcia/bitwarden_rs/issues/). Make sure there aren't any similar issues open, though!
|
||||||
|
|
||||||
|
If you prefer to chat, we're usually hanging around at [#bitwarden_rs:matrix.org](https://matrix.to/#/#bitwarden_rs:matrix.org) room on Matrix. Feel free to join us!
|
||||||
|
|
||||||
|
### Sponsors
|
||||||
|
Thanks for your contribution to the project!
|
||||||
|
|
||||||
|
- [@ChonoN](https://github.com/ChonoN)
|
65
jails/bitwarden/update.sh
Executable file
65
jails/bitwarden/update.sh
Executable file
@ -0,0 +1,65 @@
|
|||||||
|
#!/usr/local/bin/bash
|
||||||
|
# This file contains the update script for bitwarden
|
||||||
|
# Due to it being build from scratch or downloaded directly to execution dir,
|
||||||
|
# Update for Bitwarden is pretty similair to installation
|
||||||
|
|
||||||
|
# Initialise defaults
|
||||||
|
JAIL_NAME="bitwarden"
|
||||||
|
DB_DATABASE=${JAIL_NAME}
|
||||||
|
DB_USER=${JAIL_NAME}
|
||||||
|
INSTALL_TYPE=${bitwarden_type}
|
||||||
|
DB_HOST="$(sed 's|\(.*\)/.*|\1|' <<<"${mariadb_ip4_addr}"):3306"
|
||||||
|
DB_PASSWORD="${bitwarden_db_password}"
|
||||||
|
DB_STRING="mysql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}/${DB_DATABASE}"
|
||||||
|
ADMIN_TOKEN=${bitwarden_admin_token}
|
||||||
|
|
||||||
|
if [ -z "${ADMIN_TOKEN}" ]; then
|
||||||
|
ADMIN_TOKEN=$(openssl rand -base64 16)
|
||||||
|
fi
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} service bitwarden stop
|
||||||
|
|
||||||
|
# install latest rust version, pkg version is outdated and can't build bitwarden_rs
|
||||||
|
iocage exec ${JAIL_NAME} "curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y"
|
||||||
|
|
||||||
|
# Install Bitwarden_rs
|
||||||
|
iocage exec ${JAIL_NAME} "git -C /usr/local/share/bitwarden/src fetch"
|
||||||
|
TAG=$(iocage exec ${JAIL_NAME} "git -C /usr/local/share/bitwarden/src tag --sort=v:refname | tail -n1")
|
||||||
|
iocage exec ${JAIL_NAME} "git -C /usr/local/share/bitwarden/src checkout ${TAG}"
|
||||||
|
#TODO replace with: cargo build --features mysql --release
|
||||||
|
if [ "${INSTALL_TYPE}" == "mariadb" ]; then
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features mysql --release"
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features mysql"
|
||||||
|
else
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features sqlite --release"
|
||||||
|
iocage exec ${JAIL_NAME} "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features sqlite-bundled"
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} cp -r /usr/local/share/bitwarden/src/target/release /usr/local/share/bitwarden/bin
|
||||||
|
|
||||||
|
# Download and install webvault
|
||||||
|
WEB_RELEASE_URL=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/dani-garcia/bw_web_builds/releases/latest)
|
||||||
|
WEB_TAG="${WEB_RELEASE_URL##*/}"
|
||||||
|
iocage exec ${JAIL_NAME} "fetch http://github.com/dani-garcia/bw_web_builds/releases/download/$WEB_TAG/bw_web_$WEB_TAG.tar.gz -o /usr/local/share/bitwarden"
|
||||||
|
iocage exec ${JAIL_NAME} "tar -xzvf /usr/local/share/bitwarden/bw_web_$WEB_TAG.tar.gz -C /usr/local/share/bitwarden/"
|
||||||
|
iocage exec ${JAIL_NAME} rm /usr/local/share/bitwarden/bw_web_$WEB_TAG.tar.gz
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} chown -R bitwarden:bitwarden /usr/local/share/bitwarden /config
|
||||||
|
cp ${SCRIPT_DIR}/jails/${JAIL_NAME}/includes/bitwarden.rc /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.d/bitwarden
|
||||||
|
cp ${SCRIPT_DIR}/jails/${JAIL_NAME}/includes/bitwarden.rc.conf /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.conf.d/bitwarden
|
||||||
|
echo 'export DATABASE_URL="'${DB_STRING}'"' >> /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.conf.d/bitwarden
|
||||||
|
echo 'export ADMIN_TOKEN="'${ADMIN_TOKEN}'"' >> /mnt/${global_dataset_iocage}/jails/${JAIL_NAME}/root/usr/local/etc/rc.conf.d/bitwarden
|
||||||
|
|
||||||
|
if [ "${ADMIN_TOKEN}" == "NONE" ]; then
|
||||||
|
echo "Admin_token set to NONE, disabling admin portal"
|
||||||
|
else
|
||||||
|
echo "Admin_token set and admin portal enabled"
|
||||||
|
iocage exec "${JAIL_NAME}" echo "${DB_NAME} Admin Token is ${ADMIN_TOKEN}" > /root/${JAIL_NAME}_admin_token.txt
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} chmod u+x /usr/local/etc/rc.d/bitwarden
|
||||||
|
iocage exec ${JAIL_NAME} service bitwarden restart
|
||||||
|
echo "Jail ${JAIL_NAME} finished Bitwarden update."
|
||||||
|
echo "Admin Token is ${ADMIN_TOKEN}"
|
0
jails/jackett/includes/jackett.rc
Normal file → Executable file
0
jails/jackett/includes/jackett.rc
Normal file → Executable file
0
jails/jackett/readme.md
Normal file → Executable file
0
jails/jackett/readme.md
Normal file → Executable file
0
jails/kms/includes/Activate_Office_2019_Pro.bat
Normal file → Executable file
0
jails/kms/includes/Activate_Office_2019_Pro.bat
Normal file → Executable file
0
jails/kms/includes/Activate_Windows_10_Pro.bat
Normal file → Executable file
0
jails/kms/includes/Activate_Windows_10_Pro.bat
Normal file → Executable file
0
jails/kms/includes/Activate_Windows_Server_2019_Standard.bat
Normal file → Executable file
0
jails/kms/includes/Activate_Windows_Server_2019_Standard.bat
Normal file → Executable file
0
jails/kms/includes/Office-2019-Pro-VLK-Config.xml
Normal file → Executable file
0
jails/kms/includes/Office-2019-Pro-VLK-Config.xml
Normal file → Executable file
0
jails/kms/includes/Readme.md
Normal file → Executable file
0
jails/kms/includes/Readme.md
Normal file → Executable file
0
jails/kms/includes/Setup_Office_2019_Pro.txt
Normal file → Executable file
0
jails/kms/includes/Setup_Office_2019_Pro.txt
Normal file → Executable file
0
jails/kms/includes/py_kms.rc
Normal file → Executable file
0
jails/kms/includes/py_kms.rc
Normal file → Executable file
78
jails/kms/readme.md
Executable file
78
jails/kms/readme.md
Executable file
@ -0,0 +1,78 @@
|
|||||||
|
|
||||||
|
# Original README from the py-kms github:
|
||||||
|
|
||||||
|
https://github.com/SystemRage/py-kms
|
||||||
|
|
||||||
|
## History
|
||||||
|
_py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife.info/members/183074-markedsword), which is a port of either the C##, C++, or .NET implementations of KMS Emulator. The original version was written by [CODYQX4](http://forums.mydigitallife.info/members/89933-CODYQX4) and is derived from the reverse-engineered code of Microsoft's official KMS.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- Responds to V4, V5, and V6 KMS requests.
|
||||||
|
- Supports activating:
|
||||||
|
- Windows Vista
|
||||||
|
- Windows 7
|
||||||
|
- Windows 8
|
||||||
|
- Windows 8.1
|
||||||
|
- Windows 10 ( 1511 / 1607 / 1703 / 1709 / 1803 / 1809 / 1903 / 1909 )
|
||||||
|
- Windows Server 2008
|
||||||
|
- Windows Server 2008 R2
|
||||||
|
- Windows Server 2012
|
||||||
|
- Windows Server 2012 R2
|
||||||
|
- Windows Server 2016
|
||||||
|
- Windows Server 2019
|
||||||
|
- Microsoft Office 2010 ( Volume License )
|
||||||
|
- Microsoft Office 2013 ( Volume License )
|
||||||
|
- Microsoft Office 2016 ( Volume License )
|
||||||
|
- Microsoft Office 2019 ( Volume License )
|
||||||
|
- It's written in Python:
|
||||||
|
- tested with Python 2.7.15rc1
|
||||||
|
- tested with Python 3.6.7
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
- Python 3.x or Python 2.7.x or Python 2.6.x with the `argparse` module installed.
|
||||||
|
- Tkinter module.
|
||||||
|
- If the `tzlocal` module is installed, the "Request Time" in the verbose output will be converted into local time. Otherwise, it will be in UTC.
|
||||||
|
- It can use the `sqlite3` module so you can use the database function, storing activation data so it can be recalled again.
|
||||||
|
- Installation example on Ubuntu / Mint:
|
||||||
|
- `sudo apt-get update`
|
||||||
|
- for python3
|
||||||
|
- `sudo apt-get install python3-tk python3-pip`
|
||||||
|
- `sudo pip3 install tzlocal pysqlite3`
|
||||||
|
- or for python2
|
||||||
|
- `sudo apt-get install python-tk python-pip`
|
||||||
|
- `sudo pip install tzlocal pysqlite`
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
- __NOTE__: Pay attention to how invoke scripts, if you want to run with python2 use `python...` while for python3 use `python3...`, also depending on the Python versions that resides in your PC.
|
||||||
|
- To start the server, execute `python pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is "0.0.0.0" ( all interfaces ) and the default _PORT_ is "1688".
|
||||||
|
- To run the client (only for testing purposes), use `python pykms_Client.py [IPADDRESS] [PORT]`, with the same defaults of `pykms_Server.py`.
|
||||||
|
- To show the help pages type: `python pykms_Server.py -h` and `python pykms_Client.py -h`.
|
||||||
|
- To generate a random HWID use `-w` option: `python pykms_Server.py -w RANDOM`.
|
||||||
|
- To get the HWID from any server use the client, for example type: `python pykms_Client.py 0.0.0.0 1688 -m Windows8.1 -V INFO`.
|
||||||
|
- To view a minimal set of logging information use `-V MINI` option, for example: `python pykms_Server.py -F /path/to/your/logfile.log -V MINI`.
|
||||||
|
- To redirect logging on stdout use `-F STDOUT` option, for example: `python pykms_Server.py -F STDOUT -V DEBUG`.
|
||||||
|
- You can create logfile and view logging information on stdout at the same time with `-F FILESTDOUT` option, for example: `python pykms_Server.py -F FILESTDOUT /path/to/your/logfile.log -V DEBUG`.
|
||||||
|
- Select timeout (seconds) for py-kms with `-t` option, for example `python pykms_Server.py -t 10`
|
||||||
|
- For launching py-kms GUI make executable `pykms_Server.py` file with `chmod +x /path/to/folder/py-kms/pykms_Server.py`, then simply run `pykms_Server.py` double-clicking.
|
||||||
|
- You can run py-kms deamonized (via [Etrigan](https://github.com/SystemRage/Etrigan)) using a command like: `python pykms_Server.py etrigan start` and stop it with: `python pykms_Server.py etrigan stop`.
|
||||||
|
- With Etrigan you have another way to launch py-kms GUI (specially suitable if you're using a virtualenv), so: `python pykms_Server.py etrigan start -g`
|
||||||
|
and stop the GUI with the same precedent command (or interact with EXIT button).
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
![auto-docker](https://img.shields.io/docker/cloud/automated/pykmsorg/py-kms)
|
||||||
|
![status-docker](https://img.shields.io/docker/cloud/build/pykmsorg/py-kms)
|
||||||
|
|
||||||
|
This projects has docker image support. You can find all available image configurations inside the docker folder.
|
||||||
|
There are three tags of the images available:
|
||||||
|
* `latest`, currently the same like minimal...
|
||||||
|
* `minimal`, wich is based on the python3 minimal configuration of py-kms. _This image does NOT include SQLLite support!_
|
||||||
|
* `python2`, which is fully configurable and equiped with SQLLite support and web interface.
|
||||||
|
* `python3`, which is like the `python2` tag - just with Python 3...
|
||||||
|
If you just want to use the image and don't want to build them yourself, you can use the official image at the docker hub (`pykmsorg/py-kms`).
|
||||||
|
To ensure that the image is always up-to-date you should check [watchtower](https://github.com/containrrr/watchtower) out!
|
||||||
|
|
||||||
|
## Other Important Stuff
|
||||||
|
Consult the [Wiki](https://github.com/SystemRage/py-kms/wiki) for more information about activation with _py-kms_ and to get GVLK keys.
|
||||||
|
|
||||||
|
## License
|
||||||
|
[![License](https://img.shields.io/badge/license-unlicense-lightgray.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE)
|
0
jails/lidarr/includes/lidarr.rc
Normal file → Executable file
0
jails/lidarr/includes/lidarr.rc
Normal file → Executable file
@ -1,34 +1,13 @@
|
|||||||
#!/usr/local/bin/bash
|
#!/usr/local/bin/bash
|
||||||
# This file contains the install script for lidarr
|
# This file contains the install script for lidarr
|
||||||
|
|
||||||
iocage exec lidarr mkdir -p /mnt/music
|
|
||||||
iocage exec lidarr mkdir -p /mnt/fetched
|
|
||||||
|
|
||||||
# Check if dataset for completed download and it parent dataset exist, create if they do not.
|
# Check if dataset for completed download and it parent dataset exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}" ]; then
|
createmount lidarr ${global_dataset_downloads}
|
||||||
echo "Downloads dataset does not exist... Creating... ${global_dataset_downloads}"
|
createmount lidarr ${global_dataset_downloads}/complete /mnt/fetched
|
||||||
zfs create ${global_dataset_downloads}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}/complete" ]; then
|
# Check if dataset for media library and the dataset for movies exist, create if they do not.
|
||||||
echo "Completed Downloads dataset does not exist... Creating... ${global_dataset_downloads}/complete"
|
createmount lidarr ${global_dataset_media}
|
||||||
zfs create ${global_dataset_downloads}/complete
|
createmount lidarr ${global_dataset_media}/music /mnt/music
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a lidarr /mnt/${global_dataset_downloads}/complete /mnt/fetched nullfs rw 0 0
|
|
||||||
|
|
||||||
# Check if dataset for media library and the dataset for music exist, create if they do not.
|
|
||||||
if [ ! -d "/mnt/${global_dataset_media}" ]; then
|
|
||||||
echo "Media dataset does not exist... Creating... ${global_dataset_media}"
|
|
||||||
zfs create ${global_dataset_media}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_media}/music" ]; then
|
|
||||||
echo "Music dataset does not exist... Creating... ${global_dataset_media}/music"
|
|
||||||
zfs create ${global_dataset_media}/music
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a lidarr /mnt/${global_dataset_media}/music /mnt/music nullfs rw 0 0
|
|
||||||
|
|
||||||
|
|
||||||
iocage exec lidarr ln -s /usr/local/bin/mono /usr/bin/mono
|
iocage exec lidarr ln -s /usr/local/bin/mono /usr/bin/mono
|
||||||
|
71
jails/lidarr/readme.md
Executable file
71
jails/lidarr/readme.md
Executable file
@ -0,0 +1,71 @@
|
|||||||
|
# Original README from the lidarr github:
|
||||||
|
|
||||||
|
https://github.com/lidarr/Lidarr
|
||||||
|
|
||||||
|
# Lidarr
|
||||||
|
|
||||||
|
[![Build Status](https://dev.azure.com/Lidarr/Lidarr/_apis/build/status/lidarr.Lidarr?branchName=develop)](https://dev.azure.com/Lidarr/Lidarr/_build/latest?definitionId=1&branchName=develop)
|
||||||
|
[![BrowserStack Status](https://automate.browserstack.com/badge.svg?badge_key=Z1I4SVZOMitOdENIMHpkMlN3djJiRVJkTzBpdUJ5Q2ZtWVhnYTFvYS9qcz0tLTM5THJZRkVCZlk0blp5cXFBK1BDYWc9PQ==--67f41b00af03ab78148d3d711f22ca42ab348a52)](https://automate.browserstack.com/public-build/Z1I4SVZOMitOdENIMHpkMlN3djJiRVJkTzBpdUJ5Q2ZtWVhnYTFvYS9qcz0tLTM5THJZRkVCZlk0blp5cXFBK1BDYWc9PQ==--67f41b00af03ab78148d3d711f22ca42ab348a52)
|
||||||
|
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lidarr.svg)](https://github.com/lidarr/Lidarr/wiki/Docker)
|
||||||
|
![Github Downloads](https://img.shields.io/github/downloads/lidarr/lidarr/total.svg)
|
||||||
|
[![Backers on Open Collective](https://opencollective.com/lidarr/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/lidarr/sponsors/badge.svg)](#sponsors)
|
||||||
|
|
||||||
|
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
|
||||||
|
|
||||||
|
## Major Features Include:
|
||||||
|
|
||||||
|
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
|
||||||
|
* Automatically detects new tracks.
|
||||||
|
* Can scan your existing library and download any missing tracks.
|
||||||
|
* Can watch for better quality of the tracks you already have and do an automatic upgrade.
|
||||||
|
* Automatic failed download handling will try another release if one fails
|
||||||
|
* Manual search so you can pick any release or to see why a release was not downloaded automatically
|
||||||
|
* Fully configurable track renaming
|
||||||
|
* Full integration with SABnzbd and NZBGet
|
||||||
|
* Full integration with Kodi, Plex (notification, library update, metadata)
|
||||||
|
* Full support for specials and multi-album releases
|
||||||
|
* And a beautiful UI
|
||||||
|
|
||||||
|
## Feature Requests
|
||||||
|
|
||||||
|
[![Feature Requests](http://feathub.com/lidarr/Lidarr?format=svg)](http://feathub.com/lidarr/Lidarr)
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60)](https://discord.gg/8Y7rDc9)
|
||||||
|
[![Reddit](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60)](https://www.reddit.com/r/lidarr)
|
||||||
|
[![GitHub](https://img.shields.io/badge/github-issues-red.svg?maxAge=60)](https://github.com/Lidarr/Lidarr/issues)
|
||||||
|
[![GitHub Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60)](https://github.com/Lidarr/Lidarr/wiki)
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
||||||
|
<a href="https://github.com/lidarr/Lidarr/graphs/contributors"><img src="https://opencollective.com/lidarr/contributors.svg?width=890&button=false" /></a>
|
||||||
|
|
||||||
|
|
||||||
|
## Backers
|
||||||
|
|
||||||
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/lidarr#backer)]
|
||||||
|
|
||||||
|
<a href="https://opencollective.com/lidarr#backers" target="_blank"><img src="https://opencollective.com/lidarr/backers.svg?width=890"></a>
|
||||||
|
|
||||||
|
|
||||||
|
## Sponsors
|
||||||
|
|
||||||
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/lidarr#sponsor)]
|
||||||
|
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/0/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/0/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/1/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/1/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/2/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/2/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/3/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/3/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/4/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/4/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/5/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/5/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/6/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/6/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/7/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/7/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/8/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/8/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/lidarr/sponsor/9/website" target="_blank"><img src="https://opencollective.com/lidarr/sponsor/9/avatar.svg"></a>
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
||||||
|
* Copyright 2010-2019
|
11
jails/mariadb/includes/Caddyfile
Executable file
11
jails/mariadb/includes/Caddyfile
Executable file
@ -0,0 +1,11 @@
|
|||||||
|
yourhostnamehere:80 JAIL-IP:80 {
|
||||||
|
root /usr/local/www/phpMyAdmin/
|
||||||
|
fastcgi / 127.0.0.1:9000 php {
|
||||||
|
env PATH /bin
|
||||||
|
env modHeadersAvailable true
|
||||||
|
env front_controller_active true
|
||||||
|
connect_timeout 60s
|
||||||
|
read_timeout 3600s
|
||||||
|
send_timeout 300s
|
||||||
|
}
|
||||||
|
}
|
82
jails/mariadb/includes/caddy
Executable file
82
jails/mariadb/includes/caddy
Executable file
@ -0,0 +1,82 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
#
|
||||||
|
# PROVIDE: caddy
|
||||||
|
# REQUIRE: networking
|
||||||
|
# KEYWORD: shutdown
|
||||||
|
|
||||||
|
#
|
||||||
|
# Add the following lines to /etc/rc.conf to enable caddy:
|
||||||
|
# caddy_enable (bool): Set to "NO" by default.
|
||||||
|
# Set it to "YES" to enable caddy
|
||||||
|
#
|
||||||
|
# caddy_cert_email (str): Set to "" by default.
|
||||||
|
# Defines the SSL certificate issuer email. By providing an
|
||||||
|
# email address you automatically agree to letsencrypt.org's
|
||||||
|
# general terms and conditions
|
||||||
|
#
|
||||||
|
# caddy_bin_path (str): Set to "/usr/local/bin/caddy" by default.
|
||||||
|
# Provides the path to the caddy server executable
|
||||||
|
#
|
||||||
|
# caddy_cpu (str): Set to "99%" by default.
|
||||||
|
# Configures, how much CPU capacity caddy may gain
|
||||||
|
#
|
||||||
|
# caddy_config_path (str): Set to "/usr/local/www/Caddyfile" by default.
|
||||||
|
# Defines the path for the configuration file caddy will load on boot
|
||||||
|
#
|
||||||
|
# caddy_user (str): Set to "root" by default.
|
||||||
|
# Defines the user that caddy will run on
|
||||||
|
#
|
||||||
|
# caddy_group (str): Set to "wheel" by default.
|
||||||
|
# Defines the group that caddy files will be attached to
|
||||||
|
#
|
||||||
|
# caddy_logfile (str) Set to "/var/log/caddy.log" by default.
|
||||||
|
# Defines where the process log file is written, this is not a web access log
|
||||||
|
#
|
||||||
|
# caddy_env (str) Set to "" by default.
|
||||||
|
# This allows environment variable to be set that may be required, for example when using "DNS Challenge" account credentials are required.
|
||||||
|
# e.g. (in your rc.conf) caddy_env="CLOUDFLARE_EMAIL=me@domain.com CLOUDFLARE_API_KEY=my_api_key"
|
||||||
|
#
|
||||||
|
|
||||||
|
. /etc/rc.subr
|
||||||
|
|
||||||
|
name="caddy"
|
||||||
|
rcvar="${name}_enable"
|
||||||
|
|
||||||
|
load_rc_config ${name}
|
||||||
|
|
||||||
|
: ${caddy_enable:="NO"}
|
||||||
|
: ${caddy_cert_email=""}
|
||||||
|
: ${caddy_bin_path="/usr/local/bin/caddy"}
|
||||||
|
: ${caddy_cpu="99%"} # was a bug for me that caused a crash within jails
|
||||||
|
: ${caddy_config_path="/usr/local/www/Caddyfile"}
|
||||||
|
: ${caddy_logfile="/var/log/caddy.log"}
|
||||||
|
: ${caddy_user="root"}
|
||||||
|
: ${caddy_group="wheel"}
|
||||||
|
|
||||||
|
if [ "$caddy_cert_email" = "" ]
|
||||||
|
then
|
||||||
|
echo "rc variable \$caddy_cert_email is not set. Please provide a valid SSL certificate issuer email."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
pidfile="/var/run/${name}.pid"
|
||||||
|
procname="${caddy_bin_path}" #enabled builtin pid checking for start / stop
|
||||||
|
command="/usr/sbin/daemon"
|
||||||
|
command_args="-p ${pidfile} /usr/bin/env ${caddy_env} ${procname} -cpu ${caddy_cpu} -log stdout -conf ${caddy_config_path} -agree -email ${caddy_cert_email} < /dev/null >> ${caddy_logfile} 2>&1"
|
||||||
|
|
||||||
|
start_precmd="caddy_startprecmd"
|
||||||
|
|
||||||
|
caddy_startprecmd()
|
||||||
|
{
|
||||||
|
if [ ! -e "${pidfile}" ]; then
|
||||||
|
install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${pidfile}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ ! -e "${caddy_logfile}" ]; then
|
||||||
|
install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${caddy_logfile}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
required_files="${caddy_config_path}"
|
||||||
|
|
||||||
|
run_rc_command "$1"
|
16
jails/mariadb/includes/my-system.cnf
Executable file
16
jails/mariadb/includes/my-system.cnf
Executable file
@ -0,0 +1,16 @@
|
|||||||
|
[mysqld]
|
||||||
|
innodb_file_per_table=1
|
||||||
|
transaction_isolation = READ-COMMITTED
|
||||||
|
binlog_format = ROW
|
||||||
|
|
||||||
|
symbolic-links=0
|
||||||
|
innodb_doublewrite = 0
|
||||||
|
innodb_checksum_algorithm = none
|
||||||
|
innodb_file_per_table=1
|
||||||
|
|
||||||
|
innodb_buffer_pool_size = 1G
|
||||||
|
innodb_log_buffer_size = 8M
|
||||||
|
innodb_open_files = 400
|
||||||
|
innodb_io_capacity = 400
|
||||||
|
innodb_flush_method = O_DIRECT
|
||||||
|
innodb_io_capacity = 4000
|
3
jails/mariadb/includes/my.cnf
Executable file
3
jails/mariadb/includes/my.cnf
Executable file
@ -0,0 +1,3 @@
|
|||||||
|
# MySQL client config file
|
||||||
|
[client]
|
||||||
|
password=mypassword
|
111
jails/mariadb/install.sh
Executable file
111
jails/mariadb/install.sh
Executable file
@ -0,0 +1,111 @@
|
|||||||
|
#!/usr/local/bin/bash
|
||||||
|
# This script installs the current release of Mariadb and PhpMyAdmin into a created jail
|
||||||
|
#####
|
||||||
|
#
|
||||||
|
# Init and Mounts
|
||||||
|
#
|
||||||
|
#####
|
||||||
|
|
||||||
|
# Initialise defaults
|
||||||
|
JAIL_NAME="mariadb"
|
||||||
|
JAIL_IP="$(sed 's|\(.*\)/.*|\1|' <<<"${mariadb_ip4_addr}" )"
|
||||||
|
INCLUDES_PATH="${SCRIPT_DIR}/jails/mariadb/includes"
|
||||||
|
CERT_EMAIL=${mariadb_cert_email}
|
||||||
|
DB_ROOT_PASSWORD=${mariadb_db_root_password}
|
||||||
|
DB_NAME="MariaDB"
|
||||||
|
DL_FLAGS=""
|
||||||
|
|
||||||
|
# Check that necessary variables were set by nextcloud-config
|
||||||
|
if [ -z "${mariadb_ip4_addr}" ]; then
|
||||||
|
echo 'Configuration error: The mariadb jail does NOT accept DHCP'
|
||||||
|
echo 'Please reinstall using a fixed IP adress'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Make sure DB_PATH is empty -- if not, MariaDB/PostgreSQL will choke
|
||||||
|
|
||||||
|
if [ "$(ls -A "/mnt/${global_dataset_config}/${JAIL_NAME}/db")" ]; then
|
||||||
|
echo "Reinstall of mariadb detected... Continuing"
|
||||||
|
REINSTALL="true"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Mount database dataset and set zfs preferences
|
||||||
|
createmount ${JAIL_NAME} ${global_dataset_config}/${JAIL_NAME}/db /var/db/mysql
|
||||||
|
zfs set recordsize=16K ${global_dataset_config}/${JAIL_NAME}/db
|
||||||
|
zfs set primarycache=metadata ${global_dataset_config}/${JAIL_NAME}/db
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" chown -R 88:88 /var/db/mysql
|
||||||
|
|
||||||
|
# Install includes fstab
|
||||||
|
iocage exec "${JAIL_NAME}" mkdir -p /mnt/includes
|
||||||
|
iocage fstab -a "${JAIL_NAME}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" mkdir -p /usr/local/www/phpmyadmin
|
||||||
|
iocage exec "${JAIL_NAME}" chown -R www:www /usr/local/www/phpmyadmin
|
||||||
|
|
||||||
|
#####
|
||||||
|
#
|
||||||
|
# Install mariadb, Caddy and PhpMyAdmin
|
||||||
|
#
|
||||||
|
#####
|
||||||
|
|
||||||
|
fetch -o /tmp https://getcaddy.com
|
||||||
|
if ! iocage exec "${JAIL_NAME}" bash -s personal "${DL_FLAGS}" < /tmp/getcaddy.com
|
||||||
|
then
|
||||||
|
echo "Failed to download/install Caddy"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc mysql_enable="YES"
|
||||||
|
|
||||||
|
# Copy and edit pre-written config files
|
||||||
|
echo "Copying Caddyfile for no SSL"
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/caddy /usr/local/etc/rc.d/
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/Caddyfile /usr/local/www/Caddyfile
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s/yourhostnamehere/${mariadb_host_name}/" /usr/local/www/Caddyfile
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s/JAIL-IP/${JAIL_IP}/" /usr/local/www/Caddyfile
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc caddy_enable="YES"
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc php_fpm_enable="YES"
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc caddy_cert_email="${CERT_EMAIL}"
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc caddy_env="${DNS_ENV}"
|
||||||
|
|
||||||
|
iocage restart "${JAIL_NAME}"
|
||||||
|
sleep 10
|
||||||
|
|
||||||
|
if [ "${REINSTALL}" == "true" ]; then
|
||||||
|
echo "Reinstall detected, skipping generaion of new config and database"
|
||||||
|
else
|
||||||
|
|
||||||
|
# Secure database, set root password, create Nextcloud DB, user, and password
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/my-system.cnf /var/db/mysql/my.cnf
|
||||||
|
iocage exec "${JAIL_NAME}" mysql -u root -e "DELETE FROM mysql.user WHERE User='';"
|
||||||
|
iocage exec "${JAIL_NAME}" mysql -u root -e "DELETE FROM mysql.user WHERE User='root' AND Host NOT IN ('localhost', '127.0.0.1', '::1');"
|
||||||
|
iocage exec "${JAIL_NAME}" mysql -u root -e "DROP DATABASE IF EXISTS test;"
|
||||||
|
iocage exec "${JAIL_NAME}" mysql -u root -e "DELETE FROM mysql.db WHERE Db='test' OR Db='test\\_%';"
|
||||||
|
iocage exec "${JAIL_NAME}" mysql -u root -e "UPDATE mysql.user SET Password=PASSWORD('${DB_ROOT_PASSWORD}') WHERE User='root';"
|
||||||
|
iocage exec "${JAIL_NAME}" mysqladmin reload
|
||||||
|
fi
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/my.cnf /root/.my.cnf
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s|mypassword|${DB_ROOT_PASSWORD}|" /root/.my.cnf
|
||||||
|
|
||||||
|
# Save passwords for later reference
|
||||||
|
iocage exec "${JAIL_NAME}" echo "${DB_NAME} root password is ${DB_ROOT_PASSWORD}" > /root/${JAIL_NAME}_db_password.txt
|
||||||
|
|
||||||
|
|
||||||
|
# Don't need /mnt/includes any more, so unmount it
|
||||||
|
iocage fstab -r "${JAIL_NAME}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0
|
||||||
|
|
||||||
|
# Done!
|
||||||
|
echo "Installation complete!"
|
||||||
|
echo "Using your web browser, go to http://${mariadb_host_name} to log in"
|
||||||
|
|
||||||
|
if [ "${REINSTALL}" == "true" ]; then
|
||||||
|
echo "You did a reinstall, please use your old database and account credentials"
|
||||||
|
else
|
||||||
|
echo "Database Information"
|
||||||
|
echo "--------------------"
|
||||||
|
echo "The ${DB_NAME} root password is ${DB_ROOT_PASSWORD}"
|
||||||
|
fi
|
||||||
|
echo ""
|
||||||
|
echo "All passwords are saved in /root/${JAIL_NAME}_db_password.txt"
|
91
jails/mariadb/readme.md
Executable file
91
jails/mariadb/readme.md
Executable file
@ -0,0 +1,91 @@
|
|||||||
|
# Original README from the mariadb github:
|
||||||
|
|
||||||
|
https://github.com/MariaDB/server/
|
||||||
|
|
||||||
|
Code status:
|
||||||
|
------------
|
||||||
|
|
||||||
|
* [![Travis CI status](https://secure.travis-ci.org/MariaDB/server.png?branch=10.5)](https://travis-ci.org/MariaDB/server) travis-ci.org (10.5 branch)
|
||||||
|
* [![Appveyor CI status](https://ci.appveyor.com/api/projects/status/4u6pexmtpuf8jq66?svg=true)](https://ci.appveyor.com/project/rasmushoj/server) ci.appveyor.com
|
||||||
|
|
||||||
|
## MariaDB: drop-in replacement for MySQL
|
||||||
|
|
||||||
|
MariaDB is designed as a drop-in replacement of MySQL(R) with more
|
||||||
|
features, new storage engines, fewer bugs, and better performance.
|
||||||
|
|
||||||
|
MariaDB is brought to you by the MariaDB Foundation and the MariaDB corporation.
|
||||||
|
Please read the CREDITS file for details about the MariaDB Foundation,
|
||||||
|
and who is developing MariaDB.
|
||||||
|
|
||||||
|
MariaDB is developed by many of the original developers of MySQL who
|
||||||
|
now work for the MariaDB Corporation, the MariaDB Foundation and by
|
||||||
|
many people in the community.
|
||||||
|
|
||||||
|
MySQL, which is the base of MariaDB, is a product and trademark of Oracle
|
||||||
|
Corporation, Inc. For a list of developers and other contributors,
|
||||||
|
see the Credits appendix. You can also run 'SHOW authors' to get a
|
||||||
|
list of active contributors.
|
||||||
|
|
||||||
|
A description of the MariaDB project and a manual can be found at:
|
||||||
|
|
||||||
|
https://mariadb.com/kb/en/
|
||||||
|
|
||||||
|
https://mariadb.com/kb/en/mariadb-vs-mysql-features/
|
||||||
|
|
||||||
|
https://mariadb.com/kb/en/mariadb-versus-mysql-compatibility/
|
||||||
|
|
||||||
|
https://mariadb.com/kb/en/library/new-and-old-releases/
|
||||||
|
|
||||||
|
https://mariadb.org/
|
||||||
|
|
||||||
|
As MariaDB is a full replacement of MySQL, the MySQL manual at
|
||||||
|
http://dev.mysql.com/doc is generally applicable.
|
||||||
|
|
||||||
|
Help
|
||||||
|
-----
|
||||||
|
|
||||||
|
More help is available from the Maria Discuss mailing list
|
||||||
|
https://launchpad.net/~maria-discuss
|
||||||
|
and the #maria IRC channel on Freenode.
|
||||||
|
|
||||||
|
Live QA for beginner contributors
|
||||||
|
----
|
||||||
|
MariaDB has a dedicated time each week when we answer new contributor questions live on Zulip and IRC.
|
||||||
|
From 8:00 to 10:00 UTC on Mondays, and 10:00 to 12:00 UTC on Thursdays,
|
||||||
|
anyone can ask any questions they’d like, and a live developer will be available to assist.
|
||||||
|
|
||||||
|
New contributors can ask questions any time, but we will provide immediate feedback during that interval.
|
||||||
|
|
||||||
|
Licensing
|
||||||
|
---------
|
||||||
|
|
||||||
|
***************************************************************************
|
||||||
|
|
||||||
|
NOTE:
|
||||||
|
|
||||||
|
MariaDB is specifically available only under version 2 of the GNU
|
||||||
|
General Public License (GPLv2). (I.e. Without the "any later version"
|
||||||
|
clause.) This is inherited from MySQL. Please see the README file in
|
||||||
|
the MySQL distribution for more information.
|
||||||
|
|
||||||
|
License information can be found in the COPYING file. Third party
|
||||||
|
license information can be found in the THIRDPARTY file.
|
||||||
|
|
||||||
|
***************************************************************************
|
||||||
|
|
||||||
|
Bug Reports
|
||||||
|
------------
|
||||||
|
|
||||||
|
Bug and/or error reports regarding MariaDB should be submitted at:
|
||||||
|
https://jira.mariadb.org
|
||||||
|
|
||||||
|
For reporting security vulnerabilities see:
|
||||||
|
https://mariadb.org/about/security-policy/
|
||||||
|
|
||||||
|
Bugs in the MySQL code can also be submitted at:
|
||||||
|
https://bugs.mysql.com
|
||||||
|
|
||||||
|
The code for MariaDB, including all revision history, can be found at:
|
||||||
|
https://github.com/MariaDB/server
|
||||||
|
|
||||||
|
***************************************************************************
|
34
jails/mariadb/update.sh
Executable file
34
jails/mariadb/update.sh
Executable file
@ -0,0 +1,34 @@
|
|||||||
|
#!/usr/local/bin/bash
|
||||||
|
# This file contains the update script for mariadb
|
||||||
|
|
||||||
|
JAIL_NAME="mariadb"
|
||||||
|
JAIL_IP="$(sed 's|\(.*\)/.*|\1|' <<<"${mariadb_ip4_addr}" )"
|
||||||
|
INCLUDES_PATH="${SCRIPT_DIR}/jails/mariadb/includes"
|
||||||
|
|
||||||
|
# Install includes fstab
|
||||||
|
iocage exec "${JAIL_NAME}" mkdir -p /mnt/includes
|
||||||
|
iocage fstab -a "${JAIL_NAME}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0
|
||||||
|
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} service caddy stop
|
||||||
|
iocage exec ${JAIL_NAME} service php-fpm stop
|
||||||
|
|
||||||
|
fetch -o /tmp https://getcaddy.com
|
||||||
|
if ! iocage exec "${JAIL_NAME}" bash -s personal "${DL_FLAGS}" < /tmp/getcaddy.com
|
||||||
|
then
|
||||||
|
echo "Failed to download/install Caddy"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Copy and edit pre-written config files
|
||||||
|
echo "Copying Caddyfile for no SSL"
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/caddy /usr/local/etc/rc.d/
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/Caddyfile /usr/local/www/Caddyfile
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s/yourhostnamehere/${mariadb_host_name}/" /usr/local/www/Caddyfile
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s/JAIL-IP/${JAIL_IP}/" /usr/local/www/Caddyfile
|
||||||
|
|
||||||
|
# Don't need /mnt/includes any more, so unmount it
|
||||||
|
iocage fstab -r "${JAIL_NAME}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0
|
||||||
|
|
||||||
|
iocage exec ${JAIL_NAME} service caddy start
|
||||||
|
iocage exec ${JAIL_NAME} service php-fpm start
|
674
jails/nextcloud/LICENSE
Executable file
674
jails/nextcloud/LICENSE
Executable file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
|
||||||
|
<http://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
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
82
jails/nextcloud/README.md
Executable file
82
jails/nextcloud/README.md
Executable file
@ -0,0 +1,82 @@
|
|||||||
|
# Original README from the Upstream Nextcloud-iocage install script:
|
||||||
|
|
||||||
|
https://github.com/danb35/freenas-iocage-nextcloud
|
||||||
|
|
||||||
|
|
||||||
|
# freenas-iocage-nextcloud
|
||||||
|
Script to create an iocage jail on FreeNAS for the latest Nextcloud 18 release, including Caddy 1.0, MariaDB 10.3/PostgreSQL 10, and Let's Encrypt
|
||||||
|
|
||||||
|
This script will create an iocage jail on FreeNAS 11.2-U7 or 11.3 with the latest release of Nextcloud 18, along with its dependencies. It will obtain a trusted certificate from Let's Encrypt for the system, install it, and configure it to renew automatically. It will create the Nextcloud database and generate a strong root password and user password for the database system. It will configure the jail to store the database and Nextcloud user data outside the jail, so it will not be lost in the event you need to rebuild the jail.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
This script will work with FreeNAS 11.3, and it should also work with 11.2-U7. Due to the EOL status of FreeBSD 11.2, it is unlikely to work reliably with earlier releases of FreeNAS.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Prerequisites (Let's Encrypt)
|
||||||
|
This script works best when your installation is able to obtain a certificate from [Let's Encrypt](https://letsencrypt.org/). When you use it this way, Caddy is able to handle all of the TLS-related configuration for you, obtain and renew certificates automatically, etc. In order for this to happen, you must meet the two requirements below:
|
||||||
|
|
||||||
|
* First, you must own or control a real Internet domain name. This script obtains a TLS encryption certificate from Let's Encrypt, who will only issue for public domain names. Thus, domains like `cloud.local`, `mycloud.lan`, or `nextcloud.home` won't work. Domains can be very inexpensive, and in some cases, they can be free. [Freenom](https://www.freenom.com/), for example, provides domains for free if you jump through the right hoops. [EasyDNS](https://easydns.com/) is a fine domain registrar for paid domains, costing roughly US$15 per year (which varies slightly with the top-level domain).
|
||||||
|
|
||||||
|
* Second, one of these two conditions must be met in order for Let's Encrypt to validate your control over the domain name:
|
||||||
|
|
||||||
|
* You must be able and willing to open ports 80 and 443 from the entire Internet to the jail, and leave them open. If this applies, do it **before** running this script.
|
||||||
|
* DNS hosting for the domain name needs to be with a provider that Caddy supports, to automatically update the DNS records needed to prove your control over the domain. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for the supported providers, and what information you'll need in order to proceed.
|
||||||
|
|
||||||
|
[Cloudflare](https://www.cloudflare.com/) provides DNS hosting at no cost, and it's well-supported by Caddy. Cloudflare doesn't directly provide Dynamic DNS service, but [DNS-O-Matic](https://dnsomatic.com/) is a Dynamic DNS provider that will interface with many DNS hosts including Cloudflare, and is also free of charge. So, even if you have a dynamic IP address (as most residential Internet users do), you don't have your own domain, and you aren't willing to pay for a domain or any other relevant service, and you aren't willing to open any ports from the Internet to your system, you can still get a trusted certificate from Let's Encrypt by following these steps:
|
||||||
|
|
||||||
|
* Register a free domain with Freenom. Be sure to keep up with the renewal requirements.
|
||||||
|
* Sign up for a free account with Cloudflare, and activate it for free DNS service only on your domain.
|
||||||
|
* Tell Freenom to use Cloudflare for DNS for your domain.
|
||||||
|
* Sign up for a free account with DNS-O-Matic, and configure it to update your Cloudflare DNS.
|
||||||
|
* Set up FreeNAS (see [this thread](https://www.ixsystems.com/community/threads/dns-o-matic-dynamic-dns-configuration.10326/)), your router, or whatever you prefer to update DNS-O-Matic as your IP address changes.
|
||||||
|
* Set up this script to do DNS validation, tell it to use the cloudflare plugin, and give it your email address and Global API key.
|
||||||
|
|
||||||
|
If you aren't able or willing to obtain a certificate from Let's Encrypt, this script also supports configuring Caddy with a self-signed certificate, or with no certificate (and thus no HTTPS) at all.
|
||||||
|
|
||||||
|
### Prerequisites (Other)
|
||||||
|
Although not required, it's recommended to create two datasets on your main storage pool: one named `files`, which will store the Nextcloud user data; and one called `db`, which will store the SQL database. For optimal performance, set the record size of the `db` dataset to 16 KB (under Advanced Settings in the FreeNAS web GUI). It's also recommended to cache only metadata on the `db` dataset; you can do this by running `zfs set primarycache=metadata poolname/db`.
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
Download the repository to a convenient directory on your FreeNAS system by running `git clone https://github.com/danb35/freenas-iocage-nextcloud`. Then change into the new directory and create a file called `nextcloud-config`. It should look like this:
|
||||||
|
```
|
||||||
|
JAIL_IP="192.168.1.199"
|
||||||
|
DEFAULT_GW_IP="192.168.1.1"
|
||||||
|
POOL_PATH="/mnt/tank"
|
||||||
|
TIME_ZONE="America/New_York"
|
||||||
|
HOST_NAME="YOUR_FQDN"
|
||||||
|
STANDALONE_CERT=1
|
||||||
|
CERT_EMAIL="me@example.com"
|
||||||
|
```
|
||||||
|
Many of the options are self-explanatory, and all should be adjusted to suit your needs, but only a few are mandatory. The mandatory options are:
|
||||||
|
|
||||||
|
* JAIL_IP is the IP address for your jail
|
||||||
|
* DEFAULT_GW_IP is the address for your default gateway
|
||||||
|
* POOL_PATH is the path for your data pool.
|
||||||
|
* TIME_ZONE is the time zone of your location, in PHP notation--see the [PHP manual](http://php.net/manual/en/timezones.php) for a list of all valid time zones.
|
||||||
|
* HOST_NAME is the fully-qualified domain name you want to assign to your installation. You must own (or at least control) this domain, because Let's Encrypt will test that control.
|
||||||
|
* DNS_CERT, STANDALONE_CERT, SELFSIGNED_CERT, and NO_CERT determine which method will be used to generate a TLS certificate (or, in the case of NO_CERT, indicate that you don't want to use SSL at all). DNS_CERT and STANDALONE_CERT indicate use of DNS or HTTP validation for Let's Encrypt, respectively. One **and only one** of these must be set to 1.
|
||||||
|
* CERT_EMAIL is the email address Let's Encrypt will use to notify you of certificate expiration. This is mandatory regardless of whether you're using Let's Encrypt (Caddy won't start without it), but it's only used with Let's Encrypt. If you are **not** using one of the Let's Encrypt certificate options, you can set this to a dummy address as above. If you **are** using Let's Encrypt, though, it should be set to a valid address for the system admin.
|
||||||
|
* DNS_PLUGIN: If DNS_CERT is set, DNS_PLUGIN must contain the name of the DNS validation plugin you'll use with Caddy to validate domain control. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for the available plugins, but omit the leading "tls.dns.". For example, to use Cloudflare, set `DNS_PLUGIN="cloudflare"`.
|
||||||
|
* DNS_ENV: If DNS_CERT is set, DNS_ENV must contain the authentication credentials for your DNS provider. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for further details. For Cloudflare, you'd set `DNS_ENV="CLOUDFLARE_EMAIL=foo@bar.baz CLOUDFLARE_API_KEY=blah"`, using your the email address of your Cloudflare account and your Global API key--the newer API tokens aren't currently supported.
|
||||||
|
|
||||||
|
In addition, there are some other options which have sensible defaults, but can be adjusted if needed. These are:
|
||||||
|
|
||||||
|
* JAIL_NAME: The name of the jail, defaults to "nextcloud"
|
||||||
|
* DB_PATH, FILES_PATH, and PORTS_PATH: These are the paths to your database files, your data files, and the FreeBSD Ports collection. They default to $POOL_PATH/db, $POOL_PATH/files, and $POOL_PATH/portsnap, respectively.
|
||||||
|
* DATABASE: Which database management system to use. Default is "mariadb", but can be set to "pgsql" if you prefer to use PostgreSQL.
|
||||||
|
* INTERFACE: The network interface to use for the jail. Defaults to `vnet0`.
|
||||||
|
* VNET: Whether to use the iocage virtual network stack. Defaults to `on`.
|
||||||
|
|
||||||
|
If you're going to open ports 80 and 443 from the outside world to your jail, do so before running the script, and set STANDALONE_CERT to 1. If not, but you use a DNS provider that's supported by Caddy, set DNS_CERT to 1. If neither of these is true, you won't be able to use this script without modification.
|
||||||
|
|
||||||
|
It's also helpful if HOST_NAME resolves to your jail from **inside** your network. You'll probably need to configure this on your router. If it doesn't, you'll still be able to reach your Nextcloud installation via the jail's IP address, but you'll get certificate errors that way.
|
||||||
|
|
||||||
|
### Execution
|
||||||
|
Once you've downloaded the script and prepared the configuration file, run this script (`./nextcloud-jail.sh`). The script will run for several minutes. When it finishes, your jail will be created, Nextcloud will be installed and configured, and you'll be shown the randomly-generated password for the default user ("admin"). You can then log in and create users, add data, and generally do whatever else you like.
|
||||||
|
|
||||||
|
### Obtaining a trusted Let's Encrypt cert
|
||||||
|
This configuration generated by this script will obtain certs from a non-trusted certificate authority by default. This is to prevent you from exhausting the [Let's Encrypt rate limits](https://letsencrypt.org/docs/rate-limits/) while you're testing things out. Once you're sure things are working, you'll want to get a trusted cert instead. To do this, you can use a simple script that's included. As long as you haven't changed the default jail name, you can do this by running `iocage exec nextcloud /root/remove-staging.sh`.
|
||||||
|
|
||||||
|
### To Do
|
||||||
|
I'd appreciate any suggestions (or, better yet, pull requests) to improve the various config files I'm using. Most of them are adapted from the default configuration files that ship with the software in question, and have only been lightly edited to work in this application. But if there are changes to settings or organization that could improve performance, reliability, or security, I'd like to hear about them.
|
127
jails/nextcloud/includes/Caddyfile
Executable file
127
jails/nextcloud/includes/Caddyfile
Executable file
@ -0,0 +1,127 @@
|
|||||||
|
yourhostnamehere JAIL-IP {
|
||||||
|
|
||||||
|
root /usr/local/www/nextcloud
|
||||||
|
log /var/log/nextcloud_access.log
|
||||||
|
errors /var/log/nextcloud_errors.log
|
||||||
|
|
||||||
|
tls {
|
||||||
|
ca https://acme-staging-v02.api.letsencrypt.org/directory
|
||||||
|
DNS-PLACEHOLDER
|
||||||
|
}
|
||||||
|
|
||||||
|
fastcgi / 127.0.0.1:9000 php {
|
||||||
|
env PATH /bin
|
||||||
|
env modHeadersAvailable true
|
||||||
|
env front_controller_active true
|
||||||
|
connect_timeout 60s
|
||||||
|
read_timeout 3600s
|
||||||
|
send_timeout 300s
|
||||||
|
}
|
||||||
|
|
||||||
|
header / {
|
||||||
|
Strict-Transport-Security "max-age=15768000;"
|
||||||
|
X-Content-Type-Options "nosniff"
|
||||||
|
X-XSS-Protection "1; mode=block"
|
||||||
|
X-Robots-Tag "none"
|
||||||
|
X-Download-Options "noopen"
|
||||||
|
X-Permitted-Cross-Domain-Policies "none"
|
||||||
|
X-Frame-Options "SAMEORIGIN"
|
||||||
|
Referrer-Policy "no-referrer"
|
||||||
|
}
|
||||||
|
|
||||||
|
header /core/fonts {
|
||||||
|
Cache-Control "max-age=604800"
|
||||||
|
}
|
||||||
|
|
||||||
|
# checks for images
|
||||||
|
rewrite {
|
||||||
|
ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map
|
||||||
|
r ^/index.php/.*$
|
||||||
|
to /{1} /index.php?{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/host-meta$
|
||||||
|
to /public.php?service=host-meta&{query}
|
||||||
|
}
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/host-meta\.json$
|
||||||
|
to /public.php?service=host-meta-json&{query}
|
||||||
|
}
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/webfinger$
|
||||||
|
to /public.php?service=webfinger&{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/index.php/.*$
|
||||||
|
to /index.php?{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite / {
|
||||||
|
if {path} not_starts_with /remote.php
|
||||||
|
if {path} not_starts_with /public.php
|
||||||
|
ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map .html .ttf
|
||||||
|
r ^/(.*)$
|
||||||
|
to /{1} /index.php{uri}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite / {
|
||||||
|
if {path} not /core/img/favicon.ico
|
||||||
|
if {path} not /core/img/manifest.json
|
||||||
|
if {path} not_starts_with /remote.php
|
||||||
|
if {path} not_starts_with /public.php
|
||||||
|
if {path} not_starts_with /cron.php
|
||||||
|
if {path} not_starts_with /core/ajax/update.php
|
||||||
|
if {path} not_starts_with /status.php
|
||||||
|
if {path} not_starts_with /ocs/v1.php
|
||||||
|
if {path} not_starts_with /ocs/v2.php
|
||||||
|
if {path} not /robots.txt
|
||||||
|
if {path} not_starts_with /updater/
|
||||||
|
if {path} not_starts_with /ocs-provider/
|
||||||
|
if {path} not_starts_with /ocm-provider/
|
||||||
|
if {path} not_starts_with /.well-known/
|
||||||
|
to /index.php{uri}
|
||||||
|
}
|
||||||
|
|
||||||
|
# client support (e.g. os x calendar / contacts)
|
||||||
|
redir /.well-known/carddav /remote.php/carddav 301
|
||||||
|
redir /.well-known/caldav /remote.php/caldav 301
|
||||||
|
|
||||||
|
# remove trailing / as it causes errors with php-fpm
|
||||||
|
rewrite {
|
||||||
|
r ^/remote.php/(webdav|caldav|carddav|dav)(\/?)(\/?)$
|
||||||
|
to /remote.php/{1}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/remote.php/(webdav|caldav|carddav|dav)/(.+?)(\/?)(\/?)$
|
||||||
|
to /remote.php/{1}/{2}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/public.php/(dav|webdav|caldav|carddav)(\/?)(\/?)$
|
||||||
|
to /public.php/{1}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/public.php/(dav|webdav|caldav|carddav)/(.+)(\/?)(\/?)$
|
||||||
|
to /public.php/{1}/{2}
|
||||||
|
}
|
||||||
|
|
||||||
|
# .htaccess / data / config / ... shouldn't be accessible from outside
|
||||||
|
status 404 {
|
||||||
|
/.htaccess
|
||||||
|
/data
|
||||||
|
/config
|
||||||
|
/db_structure
|
||||||
|
/.xml
|
||||||
|
/README
|
||||||
|
/3rdparty
|
||||||
|
/lib
|
||||||
|
/templates
|
||||||
|
/occ
|
||||||
|
/console.php
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
122
jails/nextcloud/includes/Caddyfile-nossl
Executable file
122
jails/nextcloud/includes/Caddyfile-nossl
Executable file
@ -0,0 +1,122 @@
|
|||||||
|
yourhostnamehere:80 JAIL-IP:80 {
|
||||||
|
|
||||||
|
root /usr/local/www/nextcloud
|
||||||
|
log /var/log/nextcloud_access.log
|
||||||
|
errors /var/log/nextcloud_errors.log
|
||||||
|
|
||||||
|
fastcgi / 127.0.0.1:9000 php {
|
||||||
|
env PATH /bin
|
||||||
|
env modHeadersAvailable true
|
||||||
|
env front_controller_active true
|
||||||
|
connect_timeout 60s
|
||||||
|
read_timeout 3600s
|
||||||
|
send_timeout 300s
|
||||||
|
}
|
||||||
|
|
||||||
|
header / {
|
||||||
|
Strict-Transport-Security "max-age=15768000;"
|
||||||
|
X-Content-Type-Options "nosniff"
|
||||||
|
X-XSS-Protection "1; mode=block"
|
||||||
|
X-Robots-Tag "none"
|
||||||
|
X-Download-Options "noopen"
|
||||||
|
X-Permitted-Cross-Domain-Policies "none"
|
||||||
|
X-Frame-Options "SAMEORIGIN"
|
||||||
|
Referrer-Policy "no-referrer"
|
||||||
|
}
|
||||||
|
|
||||||
|
header /core/fonts {
|
||||||
|
Cache-Control "max-age=604800"
|
||||||
|
}
|
||||||
|
|
||||||
|
# checks for images
|
||||||
|
rewrite {
|
||||||
|
ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map
|
||||||
|
r ^/index.php/.*$
|
||||||
|
to /{1} /index.php?{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/host-meta$
|
||||||
|
to /public.php?service=host-meta&{query}
|
||||||
|
}
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/host-meta\.json$
|
||||||
|
to /public.php?service=host-meta-json&{query}
|
||||||
|
}
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/webfinger$
|
||||||
|
to /public.php?service=webfinger&{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/index.php/.*$
|
||||||
|
to /index.php?{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite / {
|
||||||
|
if {path} not_starts_with /remote.php
|
||||||
|
if {path} not_starts_with /public.php
|
||||||
|
ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map .html .ttf
|
||||||
|
r ^/(.*)$
|
||||||
|
to /{1} /index.php{uri}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite / {
|
||||||
|
if {path} not /core/img/favicon.ico
|
||||||
|
if {path} not /core/img/manifest.json
|
||||||
|
if {path} not_starts_with /remote.php
|
||||||
|
if {path} not_starts_with /public.php
|
||||||
|
if {path} not_starts_with /cron.php
|
||||||
|
if {path} not_starts_with /core/ajax/update.php
|
||||||
|
if {path} not_starts_with /status.php
|
||||||
|
if {path} not_starts_with /ocs/v1.php
|
||||||
|
if {path} not_starts_with /ocs/v2.php
|
||||||
|
if {path} not /robots.txt
|
||||||
|
if {path} not_starts_with /updater/
|
||||||
|
if {path} not_starts_with /ocs-provider/
|
||||||
|
if {path} not_starts_with /ocm-provider/
|
||||||
|
if {path} not_starts_with /.well-known/
|
||||||
|
to /index.php{uri}
|
||||||
|
}
|
||||||
|
|
||||||
|
# client support (e.g. os x calendar / contacts)
|
||||||
|
redir /.well-known/carddav /remote.php/carddav 301
|
||||||
|
redir /.well-known/caldav /remote.php/caldav 301
|
||||||
|
|
||||||
|
# remove trailing / as it causes errors with php-fpm
|
||||||
|
rewrite {
|
||||||
|
r ^/remote.php/(webdav|caldav|carddav|dav)(\/?)(\/?)$
|
||||||
|
to /remote.php/{1}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/remote.php/(webdav|caldav|carddav|dav)/(.+?)(\/?)(\/?)$
|
||||||
|
to /remote.php/{1}/{2}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/public.php/(dav|webdav|caldav|carddav)(\/?)(\/?)$
|
||||||
|
to /public.php/{1}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/public.php/(dav|webdav|caldav|carddav)/(.+)(\/?)(\/?)$
|
||||||
|
to /public.php/{1}/{2}
|
||||||
|
}
|
||||||
|
|
||||||
|
# .htaccess / data / config / ... shouldn't be accessible from outside
|
||||||
|
status 404 {
|
||||||
|
/.htaccess
|
||||||
|
/data
|
||||||
|
/config
|
||||||
|
/db_structure
|
||||||
|
/.xml
|
||||||
|
/README
|
||||||
|
/3rdparty
|
||||||
|
/lib
|
||||||
|
/templates
|
||||||
|
/occ
|
||||||
|
/console.php
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
128
jails/nextcloud/includes/Caddyfile-selfsigned
Executable file
128
jails/nextcloud/includes/Caddyfile-selfsigned
Executable file
@ -0,0 +1,128 @@
|
|||||||
|
http://yourhostnamehere http://JAIL-IP {
|
||||||
|
redir https://yourhostnamehere{uri}
|
||||||
|
}
|
||||||
|
|
||||||
|
https://yourhostnamehere https://JAIL-IP {
|
||||||
|
|
||||||
|
root /usr/local/www/nextcloud
|
||||||
|
log /var/log/nextcloud_access.log
|
||||||
|
errors /var/log/nextcloud_errors.log
|
||||||
|
|
||||||
|
tls /config/ssl/fullchain.pem /config/ssl/privkey.pem
|
||||||
|
|
||||||
|
fastcgi / 127.0.0.1:9000 php {
|
||||||
|
env PATH /bin
|
||||||
|
env modHeadersAvailable true
|
||||||
|
env front_controller_active true
|
||||||
|
connect_timeout 60s
|
||||||
|
read_timeout 3600s
|
||||||
|
send_timeout 300s
|
||||||
|
}
|
||||||
|
|
||||||
|
header / {
|
||||||
|
Strict-Transport-Security "max-age=15768000;"
|
||||||
|
X-Content-Type-Options "nosniff"
|
||||||
|
X-XSS-Protection "1; mode=block"
|
||||||
|
X-Robots-Tag "none"
|
||||||
|
X-Download-Options "noopen"
|
||||||
|
X-Permitted-Cross-Domain-Policies "none"
|
||||||
|
X-Frame-Options "SAMEORIGIN"
|
||||||
|
Referrer-Policy "no-referrer"
|
||||||
|
}
|
||||||
|
|
||||||
|
header /core/fonts {
|
||||||
|
Cache-Control "max-age=604800"
|
||||||
|
}
|
||||||
|
|
||||||
|
# checks for images
|
||||||
|
rewrite {
|
||||||
|
ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map
|
||||||
|
r ^/index.php/.*$
|
||||||
|
to /{1} /index.php?{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/host-meta$
|
||||||
|
to /public.php?service=host-meta&{query}
|
||||||
|
}
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/host-meta\.json$
|
||||||
|
to /public.php?service=host-meta-json&{query}
|
||||||
|
}
|
||||||
|
rewrite {
|
||||||
|
r ^/\.well-known/webfinger$
|
||||||
|
to /public.php?service=webfinger&{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/index.php/.*$
|
||||||
|
to /index.php?{query}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite / {
|
||||||
|
if {path} not_starts_with /remote.php
|
||||||
|
if {path} not_starts_with /public.php
|
||||||
|
ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map .html .ttf
|
||||||
|
r ^/(.*)$
|
||||||
|
to /{1} /index.php{uri}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite / {
|
||||||
|
if {path} not /core/img/favicon.ico
|
||||||
|
if {path} not /core/img/manifest.json
|
||||||
|
if {path} not_starts_with /remote.php
|
||||||
|
if {path} not_starts_with /public.php
|
||||||
|
if {path} not_starts_with /cron.php
|
||||||
|
if {path} not_starts_with /core/ajax/update.php
|
||||||
|
if {path} not_starts_with /status.php
|
||||||
|
if {path} not_starts_with /ocs/v1.php
|
||||||
|
if {path} not_starts_with /ocs/v2.php
|
||||||
|
if {path} not /robots.txt
|
||||||
|
if {path} not_starts_with /updater/
|
||||||
|
if {path} not_starts_with /ocs-provider/
|
||||||
|
if {path} not_starts_with /ocm-provider/
|
||||||
|
if {path} not_starts_with /.well-known/
|
||||||
|
to /index.php{uri}
|
||||||
|
}
|
||||||
|
|
||||||
|
# client support (e.g. os x calendar / contacts)
|
||||||
|
redir /.well-known/carddav /remote.php/carddav 301
|
||||||
|
redir /.well-known/caldav /remote.php/caldav 301
|
||||||
|
|
||||||
|
# remove trailing / as it causes errors with php-fpm
|
||||||
|
rewrite {
|
||||||
|
r ^/remote.php/(webdav|caldav|carddav|dav)(\/?)(\/?)$
|
||||||
|
to /remote.php/{1}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/remote.php/(webdav|caldav|carddav|dav)/(.+?)(\/?)(\/?)$
|
||||||
|
to /remote.php/{1}/{2}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/public.php/(dav|webdav|caldav|carddav)(\/?)(\/?)$
|
||||||
|
to /public.php/{1}
|
||||||
|
}
|
||||||
|
|
||||||
|
rewrite {
|
||||||
|
r ^/public.php/(dav|webdav|caldav|carddav)/(.+)(\/?)(\/?)$
|
||||||
|
to /public.php/{1}/{2}
|
||||||
|
}
|
||||||
|
|
||||||
|
# .htaccess / data / config / ... shouldn't be accessible from outside
|
||||||
|
status 404 {
|
||||||
|
/.htaccess
|
||||||
|
/data
|
||||||
|
/config
|
||||||
|
/db_structure
|
||||||
|
/.xml
|
||||||
|
/README
|
||||||
|
/3rdparty
|
||||||
|
/lib
|
||||||
|
/templates
|
||||||
|
/occ
|
||||||
|
/console.php
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
83
jails/nextcloud/includes/caddy
Executable file
83
jails/nextcloud/includes/caddy
Executable file
@ -0,0 +1,83 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
#
|
||||||
|
# PROVIDE: caddy
|
||||||
|
# REQUIRE: networking
|
||||||
|
# KEYWORD: shutdown
|
||||||
|
|
||||||
|
#
|
||||||
|
# Add the following lines to /etc/rc.conf to enable caddy:
|
||||||
|
# caddy_enable (bool): Set to "NO" by default.
|
||||||
|
# Set it to "YES" to enable caddy
|
||||||
|
#
|
||||||
|
# caddy_cert_email (str): Set to "" by default.
|
||||||
|
# Defines the SSL certificate issuer email. By providing an
|
||||||
|
# email address you automatically agree to letsencrypt.org's
|
||||||
|
# general terms and conditions
|
||||||
|
#
|
||||||
|
# caddy_bin_path (str): Set to "/usr/local/bin/caddy" by default.
|
||||||
|
# Provides the path to the caddy server executable
|
||||||
|
#
|
||||||
|
# caddy_cpu (str): Set to "99%" by default.
|
||||||
|
# Configures, how much CPU capacity caddy may gain
|
||||||
|
#
|
||||||
|
# caddy_config_path (str): Set to "/usr/local/www/Caddyfile" by default.
|
||||||
|
# Defines the path for the configuration file caddy will load on boot
|
||||||
|
#
|
||||||
|
# caddy_user (str): Set to "root" by default.
|
||||||
|
# Defines the user that caddy will run on
|
||||||
|
#
|
||||||
|
# caddy_group (str): Set to "wheel" by default.
|
||||||
|
# Defines the group that caddy files will be attached to
|
||||||
|
#
|
||||||
|
# caddy_logfile (str) Set to "/var/log/caddy.log" by default.
|
||||||
|
# Defines where the process log file is written, this is not a web access log
|
||||||
|
#
|
||||||
|
# caddy_env (str) Set to "" by default.
|
||||||
|
# This allows environment variable to be set that may be required, for example when using "DNS Challenge" account credentials are required.
|
||||||
|
# e.g. (in your rc.conf) caddy_env="CLOUDFLARE_EMAIL=me@domain.com CLOUDFLARE_API_KEY=my_api_key"
|
||||||
|
#
|
||||||
|
|
||||||
|
. /etc/rc.subr
|
||||||
|
|
||||||
|
name="caddy"
|
||||||
|
rcvar="${name}_enable"
|
||||||
|
|
||||||
|
load_rc_config ${name}
|
||||||
|
|
||||||
|
: ${caddy_enable:="NO"}
|
||||||
|
: ${caddy_cert_email=""}
|
||||||
|
: ${caddy_bin_path="/usr/local/bin/caddy"}
|
||||||
|
: ${caddy_cpu="99%"} # was a bug for me that caused a crash within jails
|
||||||
|
: ${caddy_config_path="/usr/local/www/Caddyfile"}
|
||||||
|
: ${caddy_logfile="/var/log/caddy.log"}
|
||||||
|
: ${caddy_user="root"}
|
||||||
|
: ${caddy_group="wheel"}
|
||||||
|
: ${caddy_SNI_default=""}
|
||||||
|
|
||||||
|
if [ "$caddy_cert_email" = "" ]
|
||||||
|
then
|
||||||
|
echo "rc variable \$caddy_cert_email is not set. Please provide a valid SSL certificate issuer email."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
pidfile="/var/run/${name}.pid"
|
||||||
|
procname="${caddy_bin_path}" #enabled builtin pid checking for start / stop
|
||||||
|
command="/usr/sbin/daemon"
|
||||||
|
command_args="-p ${pidfile} /usr/bin/env ${caddy_env} ${procname} -cpu ${caddy_cpu} -log stdout -conf ${caddy_config_path} -agree -email ${caddy_cert_email} < /dev/null >> ${caddy_logfile} 2>&1"
|
||||||
|
|
||||||
|
start_precmd="caddy_startprecmd"
|
||||||
|
|
||||||
|
caddy_startprecmd()
|
||||||
|
{
|
||||||
|
if [ ! -e "${pidfile}" ]; then
|
||||||
|
install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${pidfile}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ ! -e "${caddy_logfile}" ]; then
|
||||||
|
install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${caddy_logfile}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
required_files="${caddy_config_path}"
|
||||||
|
|
||||||
|
run_rc_command "$1"
|
4
jails/nextcloud/includes/my-system.cnf
Executable file
4
jails/nextcloud/includes/my-system.cnf
Executable file
@ -0,0 +1,4 @@
|
|||||||
|
[mysqld]
|
||||||
|
innodb_file_per_table=1
|
||||||
|
transaction_isolation = READ-COMMITTED
|
||||||
|
binlog_format = ROW
|
3
jails/nextcloud/includes/my.cnf
Executable file
3
jails/nextcloud/includes/my.cnf
Executable file
@ -0,0 +1,3 @@
|
|||||||
|
# MySQL client config file
|
||||||
|
[client]
|
||||||
|
password=mypassword
|
2
jails/nextcloud/includes/pgpass
Executable file
2
jails/nextcloud/includes/pgpass
Executable file
@ -0,0 +1,2 @@
|
|||||||
|
*:*:*:root:mypassword
|
||||||
|
*:*:*:postgres:mypassword
|
1915
jails/nextcloud/includes/php.ini
Executable file
1915
jails/nextcloud/includes/php.ini
Executable file
File diff suppressed because it is too large
Load Diff
1052
jails/nextcloud/includes/redis.conf
Executable file
1052
jails/nextcloud/includes/redis.conf
Executable file
File diff suppressed because it is too large
Load Diff
5
jails/nextcloud/includes/remove-staging.sh
Executable file
5
jails/nextcloud/includes/remove-staging.sh
Executable file
@ -0,0 +1,5 @@
|
|||||||
|
#!/usr/local/bin/bash
|
||||||
|
# Remove acme-staging CA from Caddyfile, so Caddy gets production certs
|
||||||
|
|
||||||
|
sed -ri.bak 's/-staging//' /usr/local/www/Caddyfile
|
||||||
|
service caddy restart
|
1
jails/nextcloud/includes/www-crontab
Executable file
1
jails/nextcloud/includes/www-crontab
Executable file
@ -0,0 +1 @@
|
|||||||
|
*/5 * * * * /usr/local/bin/php -f /usr/local/www/nextcloud/cron.php
|
417
jails/nextcloud/includes/www.conf
Executable file
417
jails/nextcloud/includes/www.conf
Executable file
@ -0,0 +1,417 @@
|
|||||||
|
; Start a new pool named 'www'.
|
||||||
|
; the variable $pool can be used in any directive and will be replaced by the
|
||||||
|
; pool name ('www' here)
|
||||||
|
[www]
|
||||||
|
|
||||||
|
; Per pool prefix
|
||||||
|
; It only applies on the following directives:
|
||||||
|
; - 'access.log'
|
||||||
|
; - 'slowlog'
|
||||||
|
; - 'listen' (unixsocket)
|
||||||
|
; - 'chroot'
|
||||||
|
; - 'chdir'
|
||||||
|
; - 'php_values'
|
||||||
|
; - 'php_admin_values'
|
||||||
|
; When not set, the global prefix (or /usr/local) applies instead.
|
||||||
|
; Note: This directive can also be relative to the global prefix.
|
||||||
|
; Default Value: none
|
||||||
|
;prefix = /path/to/pools/$pool
|
||||||
|
|
||||||
|
; Unix user/group of processes
|
||||||
|
; Note: The user is mandatory. If the group is not set, the default user's group
|
||||||
|
; will be used.
|
||||||
|
user = www
|
||||||
|
group = www
|
||||||
|
|
||||||
|
; The address on which to accept FastCGI requests.
|
||||||
|
; Valid syntaxes are:
|
||||||
|
; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on
|
||||||
|
; a specific port;
|
||||||
|
; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on
|
||||||
|
; a specific port;
|
||||||
|
; 'port' - to listen on a TCP socket to all addresses
|
||||||
|
; (IPv6 and IPv4-mapped) on a specific port;
|
||||||
|
; '/path/to/unix/socket' - to listen on a unix socket.
|
||||||
|
; Note: This value is mandatory.
|
||||||
|
listen = 127.0.0.1:9000
|
||||||
|
|
||||||
|
; Set listen(2) backlog.
|
||||||
|
; Default Value: 511 (-1 on FreeBSD and OpenBSD)
|
||||||
|
;listen.backlog = 511
|
||||||
|
|
||||||
|
; Set permissions for unix socket, if one is used. In Linux, read/write
|
||||||
|
; permissions must be set in order to allow connections from a web server. Many
|
||||||
|
; BSD-derived systems allow connections regardless of permissions.
|
||||||
|
; Default Values: user and group are set as the running user
|
||||||
|
; mode is set to 0660
|
||||||
|
;listen.owner = www
|
||||||
|
;listen.group = www
|
||||||
|
;listen.mode = 0660
|
||||||
|
; When POSIX Access Control Lists are supported you can set them using
|
||||||
|
; these options, value is a comma separated list of user/group names.
|
||||||
|
; When set, listen.owner and listen.group are ignored
|
||||||
|
;listen.acl_users =
|
||||||
|
;listen.acl_groups =
|
||||||
|
|
||||||
|
; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect.
|
||||||
|
; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original
|
||||||
|
; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address
|
||||||
|
; must be separated by a comma. If this value is left blank, connections will be
|
||||||
|
; accepted from any ip address.
|
||||||
|
; Default Value: any
|
||||||
|
;listen.allowed_clients = 127.0.0.1
|
||||||
|
|
||||||
|
; Specify the nice(2) priority to apply to the pool processes (only if set)
|
||||||
|
; The value can vary from -19 (highest priority) to 20 (lower priority)
|
||||||
|
; Note: - It will only work if the FPM master process is launched as root
|
||||||
|
; - The pool processes will inherit the master process priority
|
||||||
|
; unless it specified otherwise
|
||||||
|
; Default Value: no set
|
||||||
|
; process.priority = -19
|
||||||
|
|
||||||
|
; Choose how the process manager will control the number of child processes.
|
||||||
|
; Possible Values:
|
||||||
|
; static - a fixed number (pm.max_children) of child processes;
|
||||||
|
; dynamic - the number of child processes are set dynamically based on the
|
||||||
|
; following directives. With this process management, there will be
|
||||||
|
; always at least 1 children.
|
||||||
|
; pm.max_children - the maximum number of children that can
|
||||||
|
; be alive at the same time.
|
||||||
|
; pm.start_servers - the number of children created on startup.
|
||||||
|
; pm.min_spare_servers - the minimum number of children in 'idle'
|
||||||
|
; state (waiting to process). If the number
|
||||||
|
; of 'idle' processes is less than this
|
||||||
|
; number then some children will be created.
|
||||||
|
; pm.max_spare_servers - the maximum number of children in 'idle'
|
||||||
|
; state (waiting to process). If the number
|
||||||
|
; of 'idle' processes is greater than this
|
||||||
|
; number then some children will be killed.
|
||||||
|
; ondemand - no children are created at startup. Children will be forked when
|
||||||
|
; new requests will connect. The following parameter are used:
|
||||||
|
; pm.max_children - the maximum number of children that
|
||||||
|
; can be alive at the same time.
|
||||||
|
; pm.process_idle_timeout - The number of seconds after which
|
||||||
|
; an idle process will be killed.
|
||||||
|
; Note: This value is mandatory.
|
||||||
|
pm = dynamic
|
||||||
|
|
||||||
|
; The number of child processes to be created when pm is set to 'static' and the
|
||||||
|
; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'.
|
||||||
|
; This value sets the limit on the number of simultaneous requests that will be
|
||||||
|
; served. Equivalent to the ApacheMaxClients directive with mpm_prefork.
|
||||||
|
; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP
|
||||||
|
; CGI. The below defaults are based on a server without much resources. Don't
|
||||||
|
; forget to tweak pm.* to fit your needs.
|
||||||
|
; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand'
|
||||||
|
; Note: This value is mandatory.
|
||||||
|
pm.max_children = 10
|
||||||
|
|
||||||
|
; The number of child processes created on startup.
|
||||||
|
; Note: Used only when pm is set to 'dynamic'
|
||||||
|
; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2
|
||||||
|
pm.start_servers = 2
|
||||||
|
|
||||||
|
; The desired minimum number of idle server processes.
|
||||||
|
; Note: Used only when pm is set to 'dynamic'
|
||||||
|
; Note: Mandatory when pm is set to 'dynamic'
|
||||||
|
pm.min_spare_servers = 1
|
||||||
|
|
||||||
|
; The desired maximum number of idle server processes.
|
||||||
|
; Note: Used only when pm is set to 'dynamic'
|
||||||
|
; Note: Mandatory when pm is set to 'dynamic'
|
||||||
|
pm.max_spare_servers = 3
|
||||||
|
|
||||||
|
; The number of seconds after which an idle process will be killed.
|
||||||
|
; Note: Used only when pm is set to 'ondemand'
|
||||||
|
; Default Value: 10s
|
||||||
|
;pm.process_idle_timeout = 10s;
|
||||||
|
|
||||||
|
; The number of requests each child process should execute before respawning.
|
||||||
|
; This can be useful to work around memory leaks in 3rd party libraries. For
|
||||||
|
; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
|
||||||
|
; Default Value: 0
|
||||||
|
;pm.max_requests = 500
|
||||||
|
|
||||||
|
; The URI to view the FPM status page. If this value is not set, no URI will be
|
||||||
|
; recognized as a status page. It shows the following informations:
|
||||||
|
; pool - the name of the pool;
|
||||||
|
; process manager - static, dynamic or ondemand;
|
||||||
|
; start time - the date and time FPM has started;
|
||||||
|
; start since - number of seconds since FPM has started;
|
||||||
|
; accepted conn - the number of request accepted by the pool;
|
||||||
|
; listen queue - the number of request in the queue of pending
|
||||||
|
; connections (see backlog in listen(2));
|
||||||
|
; max listen queue - the maximum number of requests in the queue
|
||||||
|
; of pending connections since FPM has started;
|
||||||
|
; listen queue len - the size of the socket queue of pending connections;
|
||||||
|
; idle processes - the number of idle processes;
|
||||||
|
; active processes - the number of active processes;
|
||||||
|
; total processes - the number of idle + active processes;
|
||||||
|
; max active processes - the maximum number of active processes since FPM
|
||||||
|
; has started;
|
||||||
|
; max children reached - number of times, the process limit has been reached,
|
||||||
|
; when pm tries to start more children (works only for
|
||||||
|
; pm 'dynamic' and 'ondemand');
|
||||||
|
; Value are updated in real time.
|
||||||
|
; Example output:
|
||||||
|
; pool: www
|
||||||
|
; process manager: static
|
||||||
|
; start time: 01/Jul/2011:17:53:49 +0200
|
||||||
|
; start since: 62636
|
||||||
|
; accepted conn: 190460
|
||||||
|
; listen queue: 0
|
||||||
|
; max listen queue: 1
|
||||||
|
; listen queue len: 42
|
||||||
|
; idle processes: 4
|
||||||
|
; active processes: 11
|
||||||
|
; total processes: 15
|
||||||
|
; max active processes: 12
|
||||||
|
; max children reached: 0
|
||||||
|
;
|
||||||
|
; By default the status page output is formatted as text/plain. Passing either
|
||||||
|
; 'html', 'xml' or 'json' in the query string will return the corresponding
|
||||||
|
; output syntax. Example:
|
||||||
|
; http://www.foo.bar/status
|
||||||
|
; http://www.foo.bar/status?json
|
||||||
|
; http://www.foo.bar/status?html
|
||||||
|
; http://www.foo.bar/status?xml
|
||||||
|
;
|
||||||
|
; By default the status page only outputs short status. Passing 'full' in the
|
||||||
|
; query string will also return status for each pool process.
|
||||||
|
; Example:
|
||||||
|
; http://www.foo.bar/status?full
|
||||||
|
; http://www.foo.bar/status?json&full
|
||||||
|
; http://www.foo.bar/status?html&full
|
||||||
|
; http://www.foo.bar/status?xml&full
|
||||||
|
; The Full status returns for each process:
|
||||||
|
; pid - the PID of the process;
|
||||||
|
; state - the state of the process (Idle, Running, ...);
|
||||||
|
; start time - the date and time the process has started;
|
||||||
|
; start since - the number of seconds since the process has started;
|
||||||
|
; requests - the number of requests the process has served;
|
||||||
|
; request duration - the duration in µs of the requests;
|
||||||
|
; request method - the request method (GET, POST, ...);
|
||||||
|
; request URI - the request URI with the query string;
|
||||||
|
; content length - the content length of the request (only with POST);
|
||||||
|
; user - the user (PHP_AUTH_USER) (or '-' if not set);
|
||||||
|
; script - the main script called (or '-' if not set);
|
||||||
|
; last request cpu - the %cpu the last request consumed
|
||||||
|
; it's always 0 if the process is not in Idle state
|
||||||
|
; because CPU calculation is done when the request
|
||||||
|
; processing has terminated;
|
||||||
|
; last request memory - the max amount of memory the last request consumed
|
||||||
|
; it's always 0 if the process is not in Idle state
|
||||||
|
; because memory calculation is done when the request
|
||||||
|
; processing has terminated;
|
||||||
|
; If the process is in Idle state, then informations are related to the
|
||||||
|
; last request the process has served. Otherwise informations are related to
|
||||||
|
; the current request being served.
|
||||||
|
; Example output:
|
||||||
|
; ************************
|
||||||
|
; pid: 31330
|
||||||
|
; state: Running
|
||||||
|
; start time: 01/Jul/2011:17:53:49 +0200
|
||||||
|
; start since: 63087
|
||||||
|
; requests: 12808
|
||||||
|
; request duration: 1250261
|
||||||
|
; request method: GET
|
||||||
|
; request URI: /test_mem.php?N=10000
|
||||||
|
; content length: 0
|
||||||
|
; user: -
|
||||||
|
; script: /home/fat/web/docs/php/test_mem.php
|
||||||
|
; last request cpu: 0.00
|
||||||
|
; last request memory: 0
|
||||||
|
;
|
||||||
|
; Note: There is a real-time FPM status monitoring sample web page available
|
||||||
|
; It's available in: /usr/local/share/php/fpm/status.html
|
||||||
|
;
|
||||||
|
; Note: The value must start with a leading slash (/). The value can be
|
||||||
|
; anything, but it may not be a good idea to use the .php extension or it
|
||||||
|
; may conflict with a real PHP file.
|
||||||
|
; Default Value: not set
|
||||||
|
;pm.status_path = /status
|
||||||
|
|
||||||
|
; The ping URI to call the monitoring page of FPM. If this value is not set, no
|
||||||
|
; URI will be recognized as a ping page. This could be used to test from outside
|
||||||
|
; that FPM is alive and responding, or to
|
||||||
|
; - create a graph of FPM availability (rrd or such);
|
||||||
|
; - remove a server from a group if it is not responding (load balancing);
|
||||||
|
; - trigger alerts for the operating team (24/7).
|
||||||
|
; Note: The value must start with a leading slash (/). The value can be
|
||||||
|
; anything, but it may not be a good idea to use the .php extension or it
|
||||||
|
; may conflict with a real PHP file.
|
||||||
|
; Default Value: not set
|
||||||
|
;ping.path = /ping
|
||||||
|
|
||||||
|
; This directive may be used to customize the response of a ping request. The
|
||||||
|
; response is formatted as text/plain with a 200 response code.
|
||||||
|
; Default Value: pong
|
||||||
|
;ping.response = pong
|
||||||
|
|
||||||
|
; The access log file
|
||||||
|
; Default: not set
|
||||||
|
;access.log = log/$pool.access.log
|
||||||
|
|
||||||
|
; The access log format.
|
||||||
|
; The following syntax is allowed
|
||||||
|
; %%: the '%' character
|
||||||
|
; %C: %CPU used by the request
|
||||||
|
; it can accept the following format:
|
||||||
|
; - %{user}C for user CPU only
|
||||||
|
; - %{system}C for system CPU only
|
||||||
|
; - %{total}C for user + system CPU (default)
|
||||||
|
; %d: time taken to serve the request
|
||||||
|
; it can accept the following format:
|
||||||
|
; - %{seconds}d (default)
|
||||||
|
; - %{miliseconds}d
|
||||||
|
; - %{mili}d
|
||||||
|
; - %{microseconds}d
|
||||||
|
; - %{micro}d
|
||||||
|
; %e: an environment variable (same as $_ENV or $_SERVER)
|
||||||
|
; it must be associated with embraces to specify the name of the env
|
||||||
|
; variable. Some exemples:
|
||||||
|
; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e
|
||||||
|
; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e
|
||||||
|
; %f: script filename
|
||||||
|
; %l: content-length of the request (for POST request only)
|
||||||
|
; %m: request method
|
||||||
|
; %M: peak of memory allocated by PHP
|
||||||
|
; it can accept the following format:
|
||||||
|
; - %{bytes}M (default)
|
||||||
|
; - %{kilobytes}M
|
||||||
|
; - %{kilo}M
|
||||||
|
; - %{megabytes}M
|
||||||
|
; - %{mega}M
|
||||||
|
; %n: pool name
|
||||||
|
; %o: output header
|
||||||
|
; it must be associated with embraces to specify the name of the header:
|
||||||
|
; - %{Content-Type}o
|
||||||
|
; - %{X-Powered-By}o
|
||||||
|
; - %{Transfert-Encoding}o
|
||||||
|
; - ....
|
||||||
|
; %p: PID of the child that serviced the request
|
||||||
|
; %P: PID of the parent of the child that serviced the request
|
||||||
|
; %q: the query string
|
||||||
|
; %Q: the '?' character if query string exists
|
||||||
|
; %r: the request URI (without the query string, see %q and %Q)
|
||||||
|
; %R: remote IP address
|
||||||
|
; %s: status (response code)
|
||||||
|
; %t: server time the request was received
|
||||||
|
; it can accept a strftime(3) format:
|
||||||
|
; %d/%b/%Y:%H:%M:%S %z (default)
|
||||||
|
; The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag
|
||||||
|
; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
|
||||||
|
; %T: time the log has been written (the request has finished)
|
||||||
|
; it can accept a strftime(3) format:
|
||||||
|
; %d/%b/%Y:%H:%M:%S %z (default)
|
||||||
|
; The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag
|
||||||
|
; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
|
||||||
|
; %u: remote user
|
||||||
|
;
|
||||||
|
; Default: "%R - %u %t \"%m %r\" %s"
|
||||||
|
;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%"
|
||||||
|
|
||||||
|
; The log file for slow requests
|
||||||
|
; Default Value: not set
|
||||||
|
; Note: slowlog is mandatory if request_slowlog_timeout is set
|
||||||
|
;slowlog = log/$pool.log.slow
|
||||||
|
|
||||||
|
; The timeout for serving a single request after which a PHP backtrace will be
|
||||||
|
; dumped to the 'slowlog' file. A value of '0s' means 'off'.
|
||||||
|
; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
|
||||||
|
; Default Value: 0
|
||||||
|
;request_slowlog_timeout = 0
|
||||||
|
|
||||||
|
; Depth of slow log stack trace.
|
||||||
|
; Default Value: 20
|
||||||
|
;request_slowlog_trace_depth = 20
|
||||||
|
|
||||||
|
; The timeout for serving a single request after which the worker process will
|
||||||
|
; be killed. This option should be used when the 'max_execution_time' ini option
|
||||||
|
; does not stop script execution for some reason. A value of '0' means 'off'.
|
||||||
|
; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
|
||||||
|
; Default Value: 0
|
||||||
|
;request_terminate_timeout = 0
|
||||||
|
|
||||||
|
; Set open file descriptor rlimit.
|
||||||
|
; Default Value: system defined value
|
||||||
|
;rlimit_files = 1024
|
||||||
|
|
||||||
|
; Set max core size rlimit.
|
||||||
|
; Possible Values: 'unlimited' or an integer greater or equal to 0
|
||||||
|
; Default Value: system defined value
|
||||||
|
;rlimit_core = 0
|
||||||
|
|
||||||
|
; Chroot to this directory at the start. This value must be defined as an
|
||||||
|
; absolute path. When this value is not set, chroot is not used.
|
||||||
|
; Note: you can prefix with '$prefix' to chroot to the pool prefix or one
|
||||||
|
; of its subdirectories. If the pool prefix is not set, the global prefix
|
||||||
|
; will be used instead.
|
||||||
|
; Note: chrooting is a great security feature and should be used whenever
|
||||||
|
; possible. However, all PHP paths will be relative to the chroot
|
||||||
|
; (error_log, sessions.save_path, ...).
|
||||||
|
; Default Value: not set
|
||||||
|
;chroot =
|
||||||
|
|
||||||
|
; Chdir to this directory at the start.
|
||||||
|
; Note: relative path can be used.
|
||||||
|
; Default Value: current directory or / when chroot
|
||||||
|
;chdir = /var/www
|
||||||
|
|
||||||
|
; Redirect worker stdout and stderr into main error log. If not set, stdout and
|
||||||
|
; stderr will be redirected to /dev/null according to FastCGI specs.
|
||||||
|
; Note: on highloaded environement, this can cause some delay in the page
|
||||||
|
; process time (several ms).
|
||||||
|
; Default Value: no
|
||||||
|
;catch_workers_output = yes
|
||||||
|
|
||||||
|
; Clear environment in FPM workers
|
||||||
|
; Prevents arbitrary environment variables from reaching FPM worker processes
|
||||||
|
; by clearing the environment in workers before env vars specified in this
|
||||||
|
; pool configuration are added.
|
||||||
|
; Setting to "no" will make all environment variables available to PHP code
|
||||||
|
; via getenv(), $_ENV and $_SERVER.
|
||||||
|
; Default Value: yes
|
||||||
|
;clear_env = no
|
||||||
|
|
||||||
|
; Limits the extensions of the main script FPM will allow to parse. This can
|
||||||
|
; prevent configuration mistakes on the web server side. You should only limit
|
||||||
|
; FPM to .php extensions to prevent malicious users to use other extensions to
|
||||||
|
; execute php code.
|
||||||
|
; Note: set an empty value to allow all extensions.
|
||||||
|
; Default Value: .php
|
||||||
|
;security.limit_extensions = .php .php3 .php4 .php5 .php7
|
||||||
|
|
||||||
|
; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
|
||||||
|
; the current environment.
|
||||||
|
; Default Value: clean env
|
||||||
|
env[HOSTNAME] = $HOSTNAME
|
||||||
|
env[PATH] = /usr/local/bin:/usr/bin:/bin
|
||||||
|
env[TMP] = /tmp
|
||||||
|
env[TMPDIR] = /tmp
|
||||||
|
env[TEMP] = /tmp
|
||||||
|
|
||||||
|
; Additional php.ini defines, specific to this pool of workers. These settings
|
||||||
|
; overwrite the values previously defined in the php.ini. The directives are the
|
||||||
|
; same as the PHP SAPI:
|
||||||
|
; php_value/php_flag - you can set classic ini defines which can
|
||||||
|
; be overwritten from PHP call 'ini_set'.
|
||||||
|
; php_admin_value/php_admin_flag - these directives won't be overwritten by
|
||||||
|
; PHP call 'ini_set'
|
||||||
|
; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no.
|
||||||
|
|
||||||
|
; Defining 'extension' will load the corresponding shared extension from
|
||||||
|
; extension_dir. Defining 'disable_functions' or 'disable_classes' will not
|
||||||
|
; overwrite previously defined php.ini values, but will append the new value
|
||||||
|
; instead.
|
||||||
|
|
||||||
|
; Note: path INI options can be relative and will be expanded with the prefix
|
||||||
|
; (pool, global or /usr/local)
|
||||||
|
|
||||||
|
; Default Value: nothing is defined by default except the values in php.ini and
|
||||||
|
; specified at startup with the -d argument
|
||||||
|
;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com
|
||||||
|
;php_flag[display_errors] = off
|
||||||
|
;php_admin_value[error_log] = /var/log/fpm-php.www.log
|
||||||
|
;php_admin_flag[log_errors] = on
|
||||||
|
;php_admin_value[memory_limit] = 32M
|
350
jails/nextcloud/install.sh
Executable file
350
jails/nextcloud/install.sh
Executable file
@ -0,0 +1,350 @@
|
|||||||
|
#!/usr/local/bin/bash
|
||||||
|
# This script installs the current release of Nextcloud into a create jail
|
||||||
|
# Based on the example by danb35: https://github.com/danb35/freenas-iocage-nextcloud
|
||||||
|
|
||||||
|
|
||||||
|
# Initialise defaults
|
||||||
|
JAIL_NAME="nextcloud"
|
||||||
|
JAIL_IP="$(sed 's|\(.*\)/.*|\1|' <<<"${nextcloud_ip4_addr}" )"
|
||||||
|
DATABASE="$nextcloud_database"
|
||||||
|
INCLUDES_PATH="${SCRIPT_DIR}/jails/nextcloud/includes"
|
||||||
|
STANDALONE_CERT=${nextcloud_standalone_cert}
|
||||||
|
SELFSIGNED_CERT=${nextcloud_selfsigned_cert}
|
||||||
|
DNS_CERT=${nextcloud_dns_cert}
|
||||||
|
NO_CERT=${nextcloud_no_cert}
|
||||||
|
DL_FLAGS=${nextcloud_dl_flags}
|
||||||
|
DNS_SETTING=${nextcloud_dns_settings}
|
||||||
|
CERT_EMAIL=${nextcloud_cert_email}
|
||||||
|
HOST_NAME=${nextcloud_host_name}
|
||||||
|
|
||||||
|
# Only generate new DB passwords when using buildin database
|
||||||
|
# Set DB username and database to fixed "nextcloud"
|
||||||
|
|
||||||
|
if [ "${DATABASE}" = "pgsql-external" ]; then
|
||||||
|
DB_NAME="PostgreSQL"
|
||||||
|
DB_HOST="${nextcloud_db_host}"
|
||||||
|
DB_DATABASE="${nextcloud_db_database}"
|
||||||
|
DB_USER="${nextcloud_db_user}"
|
||||||
|
DB_PASSWORD="${nextcloud_db_password}"
|
||||||
|
elif [ "${DATABASE}" = "mariadb-external" ]; then
|
||||||
|
DB_NAME="MariaDB"
|
||||||
|
DB_HOST="${nextcloud_db_host}"
|
||||||
|
DB_DATABASE="${nextcloud_db_database}"
|
||||||
|
DB_USER="${nextcloud_db_user}"
|
||||||
|
DB_PASSWORD="${nextcloud_db_password}"
|
||||||
|
elif [ "${DATABASE}" = "mariadb-jail" ]; then
|
||||||
|
DB_DATABASE="nextcloud"
|
||||||
|
DB_USER="nextcloud"
|
||||||
|
DB_HOST="$(sed 's|\(.*\)/.*|\1|' <<<"${mariadb_ip4_addr}"):3306"
|
||||||
|
DB_PASSWORD="${nextcloud_db_password}"
|
||||||
|
else
|
||||||
|
echo "Invalid ${JAIL_NAME}_database selected please select one from the following options:"
|
||||||
|
echo "mariadb-jail, mariadb-external, pgsql-external"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
ADMIN_PASSWORD=$(openssl rand -base64 12)
|
||||||
|
|
||||||
|
#####
|
||||||
|
#
|
||||||
|
# Input Sanity Check
|
||||||
|
#
|
||||||
|
#####
|
||||||
|
|
||||||
|
|
||||||
|
# Check that necessary variables were set by nextcloud-config
|
||||||
|
if [ -z "${nextcloud_ip4_addr}" ]; then
|
||||||
|
echo 'Configuration error: The Nextcloud jail does NOT accept DHCP'
|
||||||
|
echo 'Please reinstall using a fixed IP adress'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${DB_PASSWORD}" ]; then
|
||||||
|
echo 'Configuration error: The Nextcloud Jail needs a database password'
|
||||||
|
echo 'Please reinstall with a defifined: db_password'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${DB_USER}" ]; then
|
||||||
|
echo 'Configuration error: The Nextcloud Jail needs a database user'
|
||||||
|
echo 'Please reinstall with a defifined: db_user'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${DB_HOST}" ]; then
|
||||||
|
echo 'Configuration error: The Nextcloud Jail needs a database host'
|
||||||
|
echo 'Please reinstall with a defifined: db_host'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${DB_DATABASE}" ]; then
|
||||||
|
echo 'Configuration error: The Nextcloud Jail needs a database name'
|
||||||
|
echo 'Please reinstall with a defifined: db_database'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -z "${nextcloud_time_zone}" ]; then
|
||||||
|
echo 'Configuration error: TIME_ZONE must be set'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ -z "${HOST_NAME}" ]; then
|
||||||
|
echo 'Configuration error: HOST_NAME must be set'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ $STANDALONE_CERT -eq 0 ] && [ $DNS_CERT -eq 0 ] && [ $NO_CERT -eq 0 ] && [ $SELFSIGNED_CERT -eq 0 ]; then
|
||||||
|
echo 'Configuration error: Either STANDALONE_CERT, DNS_CERT, NO_CERT,'
|
||||||
|
echo 'or SELFSIGNED_CERT must be set to 1.'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ $STANDALONE_CERT -eq 1 ] && [ $DNS_CERT -eq 1 ] ; then
|
||||||
|
echo 'Configuration error: Only one of STANDALONE_CERT and DNS_CERT'
|
||||||
|
echo 'may be set to 1.'
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $DNS_CERT -eq 1 ] && [ -z "${DNS_PLUGIN}" ] ; then
|
||||||
|
echo "DNS_PLUGIN must be set to a supported DNS provider."
|
||||||
|
echo "See https://caddyserver.com/docs under the heading of \"DNS Providers\" for list."
|
||||||
|
echo "Be sure to omit the prefix of \"tls.dns.\"."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ $DNS_CERT -eq 1 ] && [ -z "${DNS_ENV}" ] ; then
|
||||||
|
echo "DNS_ENV must be set to a your DNS provider\'s authentication credentials."
|
||||||
|
echo "See https://caddyserver.com/docs under the heading of \"DNS Providers\" for more."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $DNS_CERT -eq 1 ] ; then
|
||||||
|
DL_FLAGS="tls.dns.${DNS_PLUGIN}"
|
||||||
|
DNS_SETTING="dns ${DNS_PLUGIN}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Make sure DB_PATH is empty -- if not, MariaDB/PostgreSQL will choke
|
||||||
|
if [ "$(ls -A "/mnt/${global_dataset_config}/${JAIL_NAME}/config")" ]; then
|
||||||
|
echo "Reinstall of Nextcloud detected... "
|
||||||
|
echo "External database selected, unable to verify compatibility. REINSTALL MIGHT NOT WORK... Continuing"
|
||||||
|
REINSTALL="true"
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
#####
|
||||||
|
#
|
||||||
|
# Fstab And Mounts
|
||||||
|
#
|
||||||
|
#####
|
||||||
|
|
||||||
|
# Create and Mount portsnap
|
||||||
|
createmount ${JAIL_NAME} ${global_dataset_config}/portsnap
|
||||||
|
createmount ${JAIL_NAME} ${global_dataset_config}/portsnap/db /var/db/portsnap
|
||||||
|
createmount ${JAIL_NAME} ${global_dataset_config}/portsnap/ports /usr/ports
|
||||||
|
|
||||||
|
# Create and Mount Nextcloud, Config and Files
|
||||||
|
createmount ${JAIL_NAME} ${global_dataset_config}/${JAIL_NAME}/config /usr/local/www/nextcloud/config
|
||||||
|
createmount ${JAIL_NAME} ${global_dataset_config}/${JAIL_NAME}/themes /usr/local/www/nextcloud/themes
|
||||||
|
createmount ${JAIL_NAME} ${global_dataset_config}/${JAIL_NAME}/files /config/files
|
||||||
|
|
||||||
|
# Install includes fstab
|
||||||
|
iocage exec "${JAIL_NAME}" mkdir -p /mnt/includes
|
||||||
|
iocage fstab -a "${JAIL_NAME}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0
|
||||||
|
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" chown -R www:www /config/files
|
||||||
|
iocage exec "${JAIL_NAME}" chmod -R 770 /config/files
|
||||||
|
|
||||||
|
|
||||||
|
#####
|
||||||
|
#
|
||||||
|
# Basic dependency install
|
||||||
|
#
|
||||||
|
#####
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" "if [ -z /usr/ports ]; then portsnap fetch extract; else portsnap auto; fi"
|
||||||
|
|
||||||
|
if [ "${DATABASE}" = "mariadb-external" ] || [ "${DATABASE}" = "mariadb-jail" ]; then
|
||||||
|
iocage exec "${JAIL_NAME}" pkg install -qy mariadb103-client php73-pdo_mysql php73-mysqli
|
||||||
|
elif [ "${DATABASE}" = "pgsql-external" ]; then
|
||||||
|
iocage exec "${JAIL_NAME}" pkg install -qy postgresql10-client php73-pgsql php73-pdo_pgsql
|
||||||
|
fi
|
||||||
|
|
||||||
|
fetch -o /tmp https://getcaddy.com
|
||||||
|
if ! iocage exec "${JAIL_NAME}" bash -s personal "${DL_FLAGS}" < /tmp/getcaddy.com
|
||||||
|
then
|
||||||
|
echo "Failed to download/install Caddy"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc redis_enable="YES"
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc php_fpm_enable="YES"
|
||||||
|
iocage exec "${JAIL_NAME}" sh -c "make -C /usr/ports/www/php73-opcache clean install BATCH=yes"
|
||||||
|
iocage exec "${JAIL_NAME}" sh -c "make -C /usr/ports/devel/php73-pcntl clean install BATCH=yes"
|
||||||
|
|
||||||
|
|
||||||
|
#####
|
||||||
|
#
|
||||||
|
# Install Nextcloud
|
||||||
|
#
|
||||||
|
#####
|
||||||
|
|
||||||
|
FILE="latest-18.tar.bz2"
|
||||||
|
if ! iocage exec "${JAIL_NAME}" fetch -o /tmp https://download.nextcloud.com/server/releases/"${FILE}" https://download.nextcloud.com/server/releases/"${FILE}".asc https://nextcloud.com/nextcloud.asc
|
||||||
|
then
|
||||||
|
echo "Failed to download Nextcloud"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
iocage exec "${JAIL_NAME}" gpg --import /tmp/nextcloud.asc
|
||||||
|
if ! iocage exec "${JAIL_NAME}" gpg --verify /tmp/"${FILE}".asc
|
||||||
|
then
|
||||||
|
echo "GPG Signature Verification Failed!"
|
||||||
|
echo "The Nextcloud download is corrupt."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
iocage exec "${JAIL_NAME}" tar xjf /tmp/"${FILE}" -C /usr/local/www/
|
||||||
|
iocage exec "${JAIL_NAME}" chown -R www:www /usr/local/www/nextcloud/
|
||||||
|
|
||||||
|
|
||||||
|
# Generate and install self-signed cert, if necessary
|
||||||
|
if [ $SELFSIGNED_CERT -eq 1 ] && [ ! -f "/mnt/${global_dataset_config}/${JAIL_NAME}/ssl/privkey.pem" ]; then
|
||||||
|
echo "No ssl certificate present, generating self signed certificate"
|
||||||
|
if [ ! -d "/mnt/${global_dataset_config}/${JAIL_NAME}/ssl" ]; then
|
||||||
|
echo "cert folder not existing... creating..."
|
||||||
|
iocage exec ${JAIL_NAME} mkdir /config/ssl
|
||||||
|
fi
|
||||||
|
openssl req -new -newkey rsa:4096 -days 3650 -nodes -x509 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=${HOST_NAME}" -keyout "${INCLUDES_PATH}"/privkey.pem -out "${INCLUDES_PATH}"/fullchain.pem
|
||||||
|
iocage exec "${JAIL_NAME}" cp /mnt/includes/privkey.pem /config/ssl/privkey.pem
|
||||||
|
iocage exec "${JAIL_NAME}" cp /mnt/includes/fullchain.pem /config/ssl/fullchain.pem
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Copy and edit pre-written config files
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/php.ini /usr/local/etc/php.ini
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/redis.conf /usr/local/etc/redis.conf
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/www.conf /usr/local/etc/php-fpm.d/
|
||||||
|
if [ $STANDALONE_CERT -eq 1 ] || [ $DNS_CERT -eq 1 ]; then
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/remove-staging.sh /root/
|
||||||
|
fi
|
||||||
|
if [ $NO_CERT -eq 1 ]; then
|
||||||
|
echo "Copying Caddyfile for no SSL"
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/Caddyfile-nossl /usr/local/www/Caddyfile
|
||||||
|
elif [ $SELFSIGNED_CERT -eq 1 ]; then
|
||||||
|
echo "Copying Caddyfile for self-signed cert"
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/Caddyfile-selfsigned /usr/local/www/Caddyfile
|
||||||
|
else
|
||||||
|
echo "Copying Caddyfile for Let's Encrypt cert"
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/Caddyfile /usr/local/www/
|
||||||
|
fi
|
||||||
|
iocage exec "${JAIL_NAME}" cp -f /mnt/includes/caddy /usr/local/etc/rc.d/
|
||||||
|
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s/yourhostnamehere/${HOST_NAME}/" /usr/local/www/Caddyfile
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s/DNS-PLACEHOLDER/${DNS_SETTING}/" /usr/local/www/Caddyfile
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s/JAIL-IP/${JAIL_IP}/" /usr/local/www/Caddyfile
|
||||||
|
iocage exec "${JAIL_NAME}" sed -i '' "s|mytimezone|${nextcloud_time_zone}|" /usr/local/etc/php.ini
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc caddy_enable="YES"
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc caddy_cert_email="${CERT_EMAIL}"
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc caddy_SNI_default="${HOST_NAME}"
|
||||||
|
iocage exec "${JAIL_NAME}" sysrc caddy_env="${DNS_ENV}"
|
||||||
|
|
||||||
|
iocage restart "${JAIL_NAME}"
|
||||||
|
|
||||||
|
if [ "${REINSTALL}" == "true" ]; then
|
||||||
|
echo "Reinstall detected, skipping generaion of new config and database"
|
||||||
|
else
|
||||||
|
|
||||||
|
# Secure database, set root password, create Nextcloud DB, user, and password
|
||||||
|
if [ "${DATABASE}" = "mariadb-jail" ]; then
|
||||||
|
iocage exec "mariadb" mysql -u root -e "CREATE DATABASE ${DB_DATABASE};"
|
||||||
|
iocage exec "mariadb" mysql -u root -e "GRANT ALL ON ${DB_DATABASE}.* TO ${DB_USER}@${JAIL_IP} IDENTIFIED BY '${DB_PASSWORD}';"
|
||||||
|
iocage exec "mariadb" mysqladmin reload
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
# Save passwords for later reference
|
||||||
|
iocage exec "${JAIL_NAME}" echo "${DB_NAME} root password is ${DB_ROOT_PASSWORD}" > /root/${JAIL_NAME}_db_password.txt
|
||||||
|
iocage exec "${JAIL_NAME}" echo "Nextcloud database password is ${DB_PASSWORD}" >> /root/${JAIL_NAME}_db_password.txt
|
||||||
|
iocage exec "${JAIL_NAME}" echo "Nextcloud Administrator password is ${ADMIN_PASSWORD}" >> /root/${JAIL_NAME}_db_password.txt
|
||||||
|
|
||||||
|
# CLI installation and configuration of Nextcloud
|
||||||
|
if [ "${DATABASE}" = "mariadb-external" ] || [ "${DATABASE}" = "mariadb-jail" ]; then
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ maintenance:install --database=\"mysql\" --database-name=\"${DB_DATABASE}\" --database-user=\"${DB_USER}\" --database-pass=\"${DB_PASSWORD}\" --database-host=\"${DB_HOST}\" --admin-user=\"admin\" --admin-pass=\"${ADMIN_PASSWORD}\" --data-dir=\"/config/files\""
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set mysql.utf8mb4 --type boolean --value=\"true\""
|
||||||
|
elif [ "${DATABASE}" = "pgsql-external" ]; then
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ maintenance:install --database=\"pgsql\" --database-name=\"${DB_DATABASE}\" --database-user=\"${DB_USER}\" --database-pass=\"${DB_PASSWORD}\" --database-host=\"${DB_HOST}\" --admin-user=\"admin\" --admin-pass=\"${ADMIN_PASSWORD}\" --data-dir=\"/config/files\""
|
||||||
|
fi
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ db:add-missing-indices"
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ db:convert-filecache-bigint --no-interaction"
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set logtimezone --value=\"${nextcloud_time_zone}\""
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set log_type --value="file"'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set logfile --value="/var/log/nextcloud.log"'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set loglevel --value="2"'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set logrotate_size --value="104847600"'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set memcache.local --value="\OC\Memcache\APCu"'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set redis host --value="/tmp/redis.sock"'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set redis port --value=0 --type=integer'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set memcache.locking --value="\OC\Memcache\Redis"'
|
||||||
|
if [ $NO_CERT -eq 1 ]; then
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set overwrite.cli.url --value=\"http://${HOST_NAME}/\""
|
||||||
|
else
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set overwrite.cli.url --value=\"https://${HOST_NAME}/\""
|
||||||
|
fi
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set htaccess.RewriteBase --value="/"'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ maintenance:update:htaccess'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set trusted_domains 1 --value=\"${HOST_NAME}\""
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set trusted_domains 2 --value=\"${JAIL_IP}\""
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ app:enable encryption'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ encryption:enable'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ encryption:disable'
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php /usr/local/www/nextcloud/occ background:cron'
|
||||||
|
|
||||||
|
fi
|
||||||
|
|
||||||
|
iocage exec "${JAIL_NAME}" touch /var/log/nextcloud.log
|
||||||
|
iocage exec "${JAIL_NAME}" chown www /var/log/nextcloud.log
|
||||||
|
iocage exec "${JAIL_NAME}" su -m www -c 'php -f /usr/local/www/nextcloud/cron.php'
|
||||||
|
iocage exec "${JAIL_NAME}" crontab -u www /mnt/includes/www-crontab
|
||||||
|
|
||||||
|
# Don't need /mnt/includes any more, so unmount it
|
||||||
|
iocage fstab -r "${JAIL_NAME}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0
|
||||||
|
|
||||||
|
# Done!
|
||||||
|
echo "Installation complete!"
|
||||||
|
if [ $NO_CERT -eq 1 ]; then
|
||||||
|
echo "Using your web browser, go to http://${HOST_NAME} to log in"
|
||||||
|
else
|
||||||
|
echo "Using your web browser, go to https://${HOST_NAME} to log in"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "${REINSTALL}" == "true" ]; then
|
||||||
|
echo "You did a reinstall, please use your old database and account credentials"
|
||||||
|
else
|
||||||
|
|
||||||
|
echo "Default user is admin, password is ${ADMIN_PASSWORD}"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
echo "Database Information"
|
||||||
|
echo "--------------------"
|
||||||
|
echo "Database user = ${DB_USER}"
|
||||||
|
echo "Database password = ${DB_PASSWORD}"
|
||||||
|
echo ""
|
||||||
|
echo "All passwords are saved in /root/${JAIL_NAME}_db_password.txt"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
if [ $STANDALONE_CERT -eq 1 ] || [ $DNS_CERT -eq 1 ]; then
|
||||||
|
echo "You have obtained your Let's Encrypt certificate using the staging server."
|
||||||
|
echo "This certificate will not be trusted by your browser and will cause SSL errors"
|
||||||
|
echo "when you connect. Once you've verified that everything else is working"
|
||||||
|
echo "correctly, you should issue a trusted certificate. To do this, run:"
|
||||||
|
echo " iocage exec ${JAIL_NAME} /root/remove-staging.sh"
|
||||||
|
echo ""
|
||||||
|
elif [ $SELFSIGNED_CERT -eq 1 ]; then
|
||||||
|
echo "You have chosen to create a self-signed TLS certificate for your Nextcloud"
|
||||||
|
echo "installation. This certificate will not be trusted by your browser and"
|
||||||
|
echo "will cause SSL errors when you connect. If you wish to replace this certificate"
|
||||||
|
echo "with one obtained elsewhere, the private key is located at:"
|
||||||
|
echo "/config/ssl/privkey.pem"
|
||||||
|
echo "The full chain (server + intermediate certificates together) is at:"
|
||||||
|
echo "/config/ssl/fullchain.pem"
|
||||||
|
echo ""
|
||||||
|
fi
|
||||||
|
|
6
jails/nextcloud/update.sh
Executable file
6
jails/nextcloud/update.sh
Executable file
@ -0,0 +1,6 @@
|
|||||||
|
#!/usr/local/bin/bash
|
||||||
|
# This file contains the update script for nextcloud
|
||||||
|
|
||||||
|
echo "running nextcloud update"
|
||||||
|
iocage exec -f nextcloud su -m www -c "php /usr/local/www/nextcloud/updater/updater.phar --no-interaction"
|
||||||
|
iocage exec nextcloud service caddy restart
|
0
jails/organizr/includes/custom/organizr.conf
Normal file → Executable file
0
jails/organizr/includes/custom/organizr.conf
Normal file → Executable file
0
jails/organizr/includes/custom/phpblock.conf
Normal file → Executable file
0
jails/organizr/includes/custom/phpblock.conf
Normal file → Executable file
4
jails/organizr/includes/nginx.conf
Normal file → Executable file
4
jails/organizr/includes/nginx.conf
Normal file → Executable file
@ -19,7 +19,7 @@ http {
|
|||||||
listen 443 ssl;
|
listen 443 ssl;
|
||||||
server_name localhost;
|
server_name localhost;
|
||||||
include custom/organizr.conf;
|
include custom/organizr.conf;
|
||||||
ssl_certificate /config/cert/Organizr-Cert.crt; # Replace with actually valid certificate
|
ssl_certificate /config/ssl/Organizr-Cert.crt; # Replace with actually valid certificate
|
||||||
ssl_certificate_key /config/cert/Organizr-Cert.key; # Replace with actually valid certificate
|
ssl_certificate_key /config/ssl/Organizr-Cert.key; # Replace with actually valid certificate
|
||||||
}
|
}
|
||||||
}
|
}
|
@ -12,19 +12,18 @@ mv /mnt/${global_dataset_iocage}/jails/organizr/root/usr/local/etc/nginx/nginx.c
|
|||||||
cp ${SCRIPT_DIR}/jails/organizr/includes/nginx.conf /mnt/${global_dataset_iocage}/jails/organizr/root/usr/local/etc/nginx/nginx.conf
|
cp ${SCRIPT_DIR}/jails/organizr/includes/nginx.conf /mnt/${global_dataset_iocage}/jails/organizr/root/usr/local/etc/nginx/nginx.conf
|
||||||
cp -Rf ${SCRIPT_DIR}/jails/organizr/includes/custom /mnt/${global_dataset_iocage}/jails/organizr/root/usr/local/etc/nginx/custom
|
cp -Rf ${SCRIPT_DIR}/jails/organizr/includes/custom /mnt/${global_dataset_iocage}/jails/organizr/root/usr/local/etc/nginx/custom
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_config}/organizr/cert" ]; then
|
if [ ! -d "/mnt/${global_dataset_config}/organizr/ssl" ]; then
|
||||||
echo "cert folder not existing... creating..."
|
echo "cert folder not existing... creating..."
|
||||||
iocage exec organizr mkdir /config/cert
|
iocage exec organizr mkdir /config/ssl
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [ -f "/mnt/${global_dataset_config}/organizr/cert/Organizr-Cert.crt" ]; then
|
if [ -f "/mnt/${global_dataset_config}/organizr/ssl/Organizr-Cert.crt" ]; then
|
||||||
echo "certificate exist... Skipping cert generation"
|
echo "certificate exist... Skipping cert generation"
|
||||||
else
|
else
|
||||||
"No ssl certificate present, generating self signed certificate"
|
"No ssl certificate present, generating self signed certificate"
|
||||||
openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=localhost" -keyout /mnt/${global_dataset_config}/organizr/cert/Organizr-Cert.key -out /mnt/${global_dataset_config}/organizr/cert/Organizr-Cert.crt
|
openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=localhost" -keyout /mnt/${global_dataset_config}/organizr/cert/Organizr-Cert.key -out /mnt/${global_dataset_config}/organizr/cert/Organizr-Cert.crt
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
iocage exec organizr git clone https://github.com/causefx/Organizr.git /usr/local/www/Organizr
|
iocage exec organizr git clone https://github.com/causefx/Organizr.git /usr/local/www/Organizr
|
||||||
iocage exec organizr chown -R www:www /usr/local/www /config /usr/local/etc/nginx/nginx.conf /usr/local/etc/nginx/custom
|
iocage exec organizr chown -R www:www /usr/local/www /config /usr/local/etc/nginx/nginx.conf /usr/local/etc/nginx/custom
|
||||||
iocage exec organizr ln -s /config/config.php /usr/local/www/Organizr/api/config/config.php
|
iocage exec organizr ln -s /config/config.php /usr/local/www/Organizr/api/config/config.php
|
||||||
|
99
jails/organizr/readme.md
Executable file
99
jails/organizr/readme.md
Executable file
@ -0,0 +1,99 @@
|
|||||||
|
# Original README from the Organizr github repo:
|
||||||
|
|
||||||
|
https://github.com/causefx/Organizr
|
||||||
|
|
||||||
|
|
||||||
|
<p align="center"><img src="https://github.com/causefx/Organizr/raw/v2-develop/plugins/images/organizr/logo-wide.png"></p>
|
||||||
|
|
||||||
|
[![Percentage of issues still open](http://isitmaintained.com/badge/open/causefx/Organizr.svg)](http://isitmaintained.com/project/causefx/Organizr "Percentage of issues still open")
|
||||||
|
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/causefx/Organizr.svg)](http://isitmaintained.com/project/causefx/Organizr "Average time to resolve an issue")
|
||||||
|
[![GitHub stars](https://img.shields.io/github/stars/causefx/Organizr.svg)](https://github.com/causefx/Organizr/stargazers)
|
||||||
|
[![GitHub forks](https://img.shields.io/github/forks/causefx/Organizr.svg)](https://github.com/causefx/Organizr/network)
|
||||||
|
[![Docker pulls](https://img.shields.io/docker/pulls/organizrtools/organizr-v2.svg)](https://hub.docker.com/r/organizrtools/organizr-v2)
|
||||||
|
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/causefx)
|
||||||
|
[![Beerpay](https://beerpay.io/causefx/Organizr/badge.svg?style=beer-square)](https://beerpay.io/causefx/Organizr) [![Beerpay](https://beerpay.io/causefx/Organizr/make-wish.svg?style=flat-square)](https://beerpay.io/causefx/Organizr?focus=wish)
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53614282-a91e9e00-3b96-11e9-9b3e-d249775ecaa1.png">
|
||||||
|
|
||||||
|
Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. You can then work on your server with ease. Want to give users access to some Tabs? No problem, just enable user support and have them make an account. Want guests to be able to visit too? Enable Guest support for those tabs.
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53614285-a9b73480-3b96-11e9-835e-9fadd045582b.png">
|
||||||
|
|
||||||
|
- PHP 7.1.3+
|
||||||
|
- [Official Site](https://organizr.app) - Will be refreshed soon!
|
||||||
|
- [Official Discord](https://organizr.app/discord)
|
||||||
|
- [See Wiki](https://github.com/causefx/Organizr/wiki) - Will be updated soon!
|
||||||
|
- [Docker](https://hub.docker.com/r/organizrtools/organizr-v2/)
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53614284-a9b73480-3b96-11e9-9bea-d7a30b294267.png">
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53615855-35cc5a80-3b9d-11e9-882b-f09f3eb18173.png" width="23%"></img> <img src="https://user-images.githubusercontent.com/16184466/53615856-35cc5a80-3b9d-11e9-8428-1f2ae05da2c9.png" width="23%"></img> <img src="https://user-images.githubusercontent.com/16184466/53615857-35cc5a80-3b9d-11e9-82bf-91987c529e72.png" width="23%"></img> <img src="https://user-images.githubusercontent.com/16184466/53615858-35cc5a80-3b9d-11e9-8149-01a7fcd9160a.png" width="23%"></img>
|
||||||
|
|
||||||
|
[![Organizr Overview](https://img.youtube.com/vi/LZL4smFB6wU/0.jpg)](https://www.youtube.com/watch?v=LZL4smFB6wU)
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53614283-a9b73480-3b96-11e9-90ef-6e752e067884.png">
|
||||||
|
|
||||||
|
- Login with Plex/Emby/LDAP or sFTP credentials
|
||||||
|
- Custom tabs for your services
|
||||||
|
- Fullscreen Support
|
||||||
|
- Pin/Unpin sidebar
|
||||||
|
- Mobile support
|
||||||
|
- Set default page on launch
|
||||||
|
- Upload new icons with ease
|
||||||
|
- Enable or disable iFrame for your tabs
|
||||||
|
- User management support: Create, delete and promote users from the user management console
|
||||||
|
- Unlimited User Groups
|
||||||
|
- Theme-able
|
||||||
|
- Personalise any theme: Customise the look and feel of Organizr with access to the colour palette
|
||||||
|
- Organizr login log viewer
|
||||||
|
- Fail2ban support (see wiki)
|
||||||
|
- Nginx Auth_Request support
|
||||||
|
- Protect new user account creation with registration password
|
||||||
|
- 'Forgot Password' support [receive an email with your new password, prerequisites: mail server setup]
|
||||||
|
- Multiple login support
|
||||||
|
- Keyboard shortcut support (Check help tab in settings)
|
||||||
|
- Gravatar Support
|
||||||
|
- Customise the top bar by adding your own site logo or site name
|
||||||
|
- Additional language support
|
||||||
|
- Quick access tabs [access your tabs quickly e.g. www.example.com/#Sonarr]
|
||||||
|
- Many more...
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53614286-a9b73480-3b96-11e9-8495-4944b85b1313.png">
|
||||||
|
|
||||||
|
[![Feature Requests](http://feathub.com/causefx/Organizr?format=svg)](http://feathub.com/causefx/Organizr)
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53667702-fcdcc600-3c2e-11e9-8828-860e531e8096.png">
|
||||||
|
|
||||||
|
##### Usage
|
||||||
|
```
|
||||||
|
docker create \
|
||||||
|
--name=organizr \
|
||||||
|
-v <path to data>:/config \
|
||||||
|
-e PGID=<gid> -e PUID=<uid> \
|
||||||
|
-p 80:80 \
|
||||||
|
organizrtools/organizr-v2
|
||||||
|
```
|
||||||
|
##### 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 and `http://192.168.x.x:8080` would show you what's running INSIDE the container on port 80.
|
||||||
|
|
||||||
|
* `-p 80` - The port(s)
|
||||||
|
* `-v /config` - Mapping the config files for Organizr
|
||||||
|
* `-e PGID` Used for GroupID - see below for explanation
|
||||||
|
* `-e PUID` Used for UserID - see below for explanation
|
||||||
|
|
||||||
|
##### Info
|
||||||
|
* Shell access whilst the container is running: `docker exec -it organizr /bin/bash`
|
||||||
|
* To monitor the logs of the container in realtime: `docker logs -f organizr`
|
||||||
|
* Container version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizr`
|
||||||
|
* Image version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizrtools/docker-organizr-v2`
|
||||||
|
|
||||||
|
<img src="https://user-images.githubusercontent.com/16184466/53614287-a9b73480-3b96-11e9-9c8e-e32b4ae20c0d.png">
|
||||||
|
|
||||||
|
<p align="center"><a href="https://www.browserstack.com"><img src="https://avatars2.githubusercontent.com/u/1119453?s=200&v=4g"></a></p>
|
||||||
|
<p align="center"><a href="https://www.browserstack.com">BrowserStack</a> for allowing us to use their platform for testing</p>
|
||||||
|
<p>This project is supported by:</p>
|
||||||
|
<p>
|
||||||
|
<a href="https://www.digitalocean.com/">
|
||||||
|
<img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" width="201px">
|
||||||
|
</a>
|
||||||
|
</p>
|
0
jails/plex/includes/FreeBSD.conf
Normal file → Executable file
0
jails/plex/includes/FreeBSD.conf
Normal file → Executable file
@ -2,43 +2,17 @@
|
|||||||
# This file contains the install script for plex
|
# This file contains the install script for plex
|
||||||
|
|
||||||
iocage exec plex mkdir -p /usr/local/etc/pkg/repos
|
iocage exec plex mkdir -p /usr/local/etc/pkg/repos
|
||||||
iocage exec plex mkdir -p /mnt/media
|
|
||||||
iocage exec plex mkdir -p /mnt/media/movies
|
|
||||||
iocage exec plex mkdir -p /mnt/media/music
|
|
||||||
iocage exec plex mkdir -p /mnt/media/shows
|
|
||||||
|
|
||||||
# Change to to more frequent FreeBSD repo to stay up-to-date with plex more.
|
# Change to to more frequent FreeBSD repo to stay up-to-date with plex more.
|
||||||
cp ${SCRIPT_DIR}/jails/plex/includes/FreeBSD.conf /mnt/${global_dataset_iocage}/jails/plex/root/usr/local/etc/pkg/repos/FreeBSD.conf
|
cp ${SCRIPT_DIR}/jails/plex/includes/FreeBSD.conf /mnt/${global_dataset_iocage}/jails/plex/root/usr/local/etc/pkg/repos/FreeBSD.conf
|
||||||
|
|
||||||
|
|
||||||
# Check if datasets for media librarys exist, create them if they do not.
|
# Check if datasets for media librarys exist, create them if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_media}" ]; then
|
createmount plex ${global_dataset_media} /mnt/media
|
||||||
echo "Media dataset does not exist... Creating... ${global_dataset_media}"
|
createmount plex ${global_dataset_media}/movies /mnt/media/movies
|
||||||
zfs create ${global_dataset_media}
|
createmount plex ${global_dataset_media}/music /mnt/media/music
|
||||||
fi
|
createmount plex ${global_dataset_media}/shows /mnt/media/shows
|
||||||
|
|
||||||
iocage fstab -a plex /mnt/${global_dataset_media} /mnt/media nullfs rw 0 0
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_media}/shows" ]; then
|
|
||||||
echo "TV Shows dataset does not exist... Creating... ${global_dataset_media}/shows"
|
|
||||||
zfs create ${global_dataset_media}/shows
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a plex /mnt/${global_dataset_media}/shows /mnt/media/shows nullfs rw 0 0
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_media}/music" ]; then
|
|
||||||
echo "music dataset does not exist... Creating... ${global_dataset_media}/music"
|
|
||||||
zfs create ${global_dataset_media}/music
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a plex /mnt/${global_dataset_media}/music /mnt/media/music nullfs rw 0 0
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_media}/movies" ]; then
|
|
||||||
echo "movies dataset does not exist... Creating... ${global_dataset_media}/movies"
|
|
||||||
zfs create ${global_dataset_media}/movies
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a plex /mnt/${global_dataset_media}/movies /mnt/media/movies nullfs rw 0 0
|
|
||||||
|
|
||||||
|
|
||||||
iocage exec plex chown -R plex:plex /config
|
iocage exec plex chown -R plex:plex /config
|
||||||
|
7
jails/plex/readme.md
Executable file
7
jails/plex/readme.md
Executable file
@ -0,0 +1,7 @@
|
|||||||
|
# Plex
|
||||||
|
|
||||||
|
For more information about plex, please see the Plex website:
|
||||||
|
|
||||||
|
# Original plex install script guide
|
||||||
|
|
||||||
|
https://www.ixsystems.com/community/resources/fn11-3-iocage-jails-plex-tautulli-sonarr-radarr-lidarr-jackett-transmission-organizr.58/
|
0
jails/radarr/includes/radarr.rc
Normal file → Executable file
0
jails/radarr/includes/radarr.rc
Normal file → Executable file
@ -1,34 +1,13 @@
|
|||||||
#!/usr/local/bin/bash
|
#!/usr/local/bin/bash
|
||||||
# This file contains the install script for radarr
|
# This file contains the install script for radarr
|
||||||
|
|
||||||
iocage exec radarr mkdir -p /mnt/movies
|
|
||||||
iocage exec radarr mkdir -p /mnt/fetched
|
|
||||||
|
|
||||||
# Check if dataset for completed download and it parent dataset exist, create if they do not.
|
# Check if dataset for completed download and it parent dataset exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}" ]; then
|
createmount radarr ${global_dataset_downloads}
|
||||||
echo "Downloads dataset does not exist... Creating... ${global_dataset_downloads}"
|
createmount radarr ${global_dataset_downloads}/complete /mnt/fetched
|
||||||
zfs create ${global_dataset_downloads}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}/complete" ]; then
|
|
||||||
echo "Completed Downloads dataset does not exist... Creating... ${global_dataset_downloads}/complete"
|
|
||||||
zfs create ${global_dataset_downloads}/complete
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a radarr /mnt/${global_dataset_downloads}/complete /mnt/fetched nullfs rw 0 0
|
|
||||||
|
|
||||||
# Check if dataset for media library and the dataset for movies exist, create if they do not.
|
# Check if dataset for media library and the dataset for movies exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_media}" ]; then
|
createmount radarr ${global_dataset_media}
|
||||||
echo "Media dataset does not exist... Creating... ${global_dataset_media}"
|
createmount radarr ${global_dataset_media}/movies /mnt/movies
|
||||||
zfs create ${global_dataset_media}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_media}/movies" ]; then
|
|
||||||
echo "Movies dataset does not exist... Creating... ${global_dataset_media}/movies"
|
|
||||||
zfs create ${global_dataset_media}/movies
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a radarr /mnt/${global_dataset_media}/movies /mnt/movies nullfs rw 0 0
|
|
||||||
|
|
||||||
iocage exec radarr ln -s /usr/local/bin/mono /usr/bin/mono
|
iocage exec radarr ln -s /usr/local/bin/mono /usr/bin/mono
|
||||||
iocage exec radarr "fetch https://github.com/Radarr/Radarr/releases/download/v0.2.0.1480/Radarr.develop.0.2.0.1480.linux.tar.gz -o /usr/local/share"
|
iocage exec radarr "fetch https://github.com/Radarr/Radarr/releases/download/v0.2.0.1480/Radarr.develop.0.2.0.1480.linux.tar.gz -o /usr/local/share"
|
||||||
|
168
jails/radarr/readme.md
Executable file
168
jails/radarr/readme.md
Executable file
@ -0,0 +1,168 @@
|
|||||||
|
# Original README from the radarr github:
|
||||||
|
|
||||||
|
https://github.com/Radarr/Radarr
|
||||||
|
|
||||||
|
# Radarr
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="/Logo/text256.png" alt="Radarr">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
**New UI Development:** For an overview of the new UI development see [DEVELOPMENT.md](https://github.com/Radarr/Radarr/blob/aphrodite/DEVELOPMENT.md).
|
||||||
|
|
||||||
|
Radarr is an __independent__ fork of [Sonarr](https://github.com/Sonarr/Sonarr) reworked for automatically downloading movies via Usenet and BitTorrent.
|
||||||
|
|
||||||
|
The project was inspired by other Usenet/BitTorrent movie downloaders such as CouchPotato.
|
||||||
|
|
||||||
|
See the [Roadmap blogpost](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html) for an overview of planned features.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
[![Installation](https://img.shields.io/badge/wiki-installation-brightgreen.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/Installation)
|
||||||
|
[![Docker](https://img.shields.io/badge/wiki-docker-1488C6.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/Docker)
|
||||||
|
[![Setup Guide](https://img.shields.io/badge/wiki-setup_guide-orange.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/Setup-Guide)
|
||||||
|
[![FAQ](https://img.shields.io/badge/wiki-FAQ-BF55EC.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/FAQ)
|
||||||
|
|
||||||
|
* [Install Radarr for your desired OS](https://github.com/Radarr/Radarr/wiki/Installation) *or* use [Docker](https://github.com/Radarr/Radarr/wiki/Docker)
|
||||||
|
* *For Linux users*, run `radarr` and *optionally* have [Radarr start automatically](https://github.com/Radarr/Radarr/wiki/Autostart-on-Linux)
|
||||||
|
* Connect to the UI through <http://localhost:7878> or <http://your-ip:7878> in your web browser
|
||||||
|
* See the [Setup Guide](https://github.com/Radarr/Radarr/wiki/Setup-Guide) for further configuration
|
||||||
|
|
||||||
|
## Downloads
|
||||||
|
|
||||||
|
| Release Type | Branch: develop (stable) | Branch: nightly (semi-unstable) | Branch: aphrodite (very-unstable) |
|
||||||
|
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| Binary Releases | [![GitHub Releases](https://img.shields.io/badge/downloads-releases-brightgreen.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/releases) | [![AppVeyor Builds](https://img.shields.io/badge/downloads-nightly-green.svg?maxAge=60&style=flat-square)](https://ci.appveyor.com/project/galli-leo/radarr-usby1/branch/develop/artifacts) | |
|
||||||
|
| Docker | [![Docker release](https://img.shields.io/badge/linuxserver-radarr:latest-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr) | [![Docker nightly](https://img.shields.io/badge/linuxserver-radarr:nightly-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr) | [![Docker aphrodite](https://img.shields.io/badge/linuxserver-radarr:preview-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr) |
|
||||||
|
| Docker | [![Docker release](https://img.shields.io/badge/hotio-radarr:latest-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/hotio/radarr) | [![Docker nightly](https://img.shields.io/badge/hotio-radarr:unstable-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/hotio/radarr) | [![Docker aphrodite](https://img.shields.io/badge/hotio-radarr:aphrodite-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/hotio/radarr) |
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
[![OpenCollective](https://opencollective.com/radarr/tiers/backer/badge.svg)](#backers)
|
||||||
|
[![OpenCollective](https://opencollective.com/radarr/tiers/flexible-sponsor/badge.svg)](#flexible-sponsors)
|
||||||
|
[![OpenCollective](https://opencollective.com/radarr/tiers/sponsor/badge.svg)](#sponsors)
|
||||||
|
|
||||||
|
[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=flat-square)](https://discord.gg/AD3UP37)
|
||||||
|
[![Reddit](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60&style=flat-square)](https://www.reddit.com/r/radarr)
|
||||||
|
[![Feathub](https://img.shields.io/badge/feathub-requests-lightgrey.svg?maxAge=60&style=flat-square)](http://feathub.com/Radarr/Radarr)
|
||||||
|
[![GitHub](https://img.shields.io/badge/github-issues-red.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/issues)
|
||||||
|
[![GitHub Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki)
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
[![GitHub issues](https://img.shields.io/github/issues/radarr/radarr.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/issues)
|
||||||
|
[![GitHub pull requests](https://img.shields.io/github/issues-pr/radarr/radarr.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/pulls)
|
||||||
|
[![GNU GPL v3](https://img.shields.io/badge/license-GNU%20GPL%20v3-blue.svg?maxAge=60&style=flat-square)](http://www.gnu.org/licenses/gpl.html)
|
||||||
|
[![Copyright 2010-2017](https://img.shields.io/badge/copyright-2017-blue.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr)
|
||||||
|
[![Github Releases](https://img.shields.io/github/downloads/Radarr/Radarr/total.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/releases/)
|
||||||
|
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg?maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr/)
|
||||||
|
[![Changelog](https://img.shields.io/github/commit-activity/w/radarr/radarr.svg?style=flat-square)](/CHANGELOG.md#unreleased)
|
||||||
|
|
||||||
|
| Service | Master | Develop |
|
||||||
|
|----------|:---------------------------:|:----------------------------:|
|
||||||
|
| AppVeyor | [![AppVeyor](https://img.shields.io/appveyor/ci/galli-leo/Radarr/master.svg?maxAge=60&style=flat-square)](https://ci.appveyor.com/project/galli-leo/Radarr) | [![AppVeyor](https://img.shields.io/appveyor/ci/galli-leo/Radarr-usby1/develop.svg?maxAge=60&style=flat-square)](https://ci.appveyor.com/project/galli-leo/Radarr-usby1) |
|
||||||
|
| Travis | [![Travis](https://img.shields.io/travis/Radarr/Radarr/master.svg?maxAge=60&style=flat-square)](https://travis-ci.org/Radarr/Radarr) | [![Travis](https://img.shields.io/travis/Radarr/Radarr/develop.svg?maxAge=60&style=flat-square)](https://travis-ci.org/Radarr/Radarr) |
|
||||||
|
|
||||||
|
### [Site and API Status](https://status.radarr.video)
|
||||||
|
|
||||||
|
| API | Updates | Sites |
|
||||||
|
|-------|:----:|:----:|
|
||||||
|
| [![API V2 (develop)](http://status.radarr.video/component/1/shield?style=flat-square)](https://api.radarr.video/v2/) | [![Update Server](http://status.radarr.video/component/4/shield?style=flat-square)](https://radarr.aeonlucid.com) | [![Radarr Mappings](http://status.radarr.video/component/6/shield?style=flat-square)](https://mappings.radarr.video/)
|
||||||
|
| [![API Staging (nightly)](http://status.radarr.video/component/2/shield?style=flat-square)](https://staging.api.radarr.video/) | [![Github Updates](http://status.radarr.video/component/5/shield?style=flat-square)](https://api.github.com/v3/) | [![Main Site](http://status.radarr.video/component/7/shield?style=flat-square)](https://radarr.video/)
|
||||||
|
|
||||||
|
Radarr is currently undergoing rapid development and pull requests are actively added into the repository.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### Current Features
|
||||||
|
|
||||||
|
* Adding new movies with lots of information, such as trailers, ratings, etc.
|
||||||
|
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
|
||||||
|
* Can watch for better quality of the movies you have and do an automatic upgrade. *eg. from DVD to Blu-Ray*
|
||||||
|
* Automatic failed download handling will try another release if one fails
|
||||||
|
* Manual search so you can pick any release or to see why a release was not downloaded automatically
|
||||||
|
* Full integration with SABnzbd and NZBGet
|
||||||
|
* Automatically searching for releases as well as RSS Sync
|
||||||
|
* Automatically importing downloaded movies
|
||||||
|
* Recognizing Special Editions, Director's Cut, etc.
|
||||||
|
* Identifying releases with hardcoded subs
|
||||||
|
* All indexers supported by Sonarr also supported
|
||||||
|
* New PassThePopcorn Indexer
|
||||||
|
* QBittorrent, Deluge, rTorrent, Transmission and uTorrent download client (Other clients are coming)
|
||||||
|
* New TorrentPotato Indexer
|
||||||
|
* Torznab Indexer now supports Movies (Works well with [Jackett](https://github.com/Jackett/Jackett))
|
||||||
|
* Scanning PreDB to know when a new release is available
|
||||||
|
* Importing movies from various online sources, such as IMDb Watchlists (A complete list can be found [here](https://github.com/Radarr/Radarr/issues/114))
|
||||||
|
* Full integration with Kodi, Plex (notification, library update)
|
||||||
|
* And a beautiful UI
|
||||||
|
* Importing Metadata such as trailers or subtitles
|
||||||
|
* Adding metadata such as posters and information for Kodi and others to use
|
||||||
|
* Advanced customization for profiles, such that Radarr will always download the copy you want
|
||||||
|
|
||||||
|
### Planned Features
|
||||||
|
|
||||||
|
See the [Roadmap blogpost](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html) for an overview of planned features.
|
||||||
|
|
||||||
|
#### [Feature Requests](http://feathub.com/Radarr/Radarr)
|
||||||
|
|
||||||
|
## Configuring the Development Environment
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
* [Visual Studio Community 2019](https://www.visualstudio.com/vs/community/) or [Rider](http://www.jetbrains.com/rider/)
|
||||||
|
* [Git](https://git-scm.com/downloads)
|
||||||
|
* [Node.js](https://nodejs.org/en/download/)
|
||||||
|
* [Yarn](https://yarnpkg.com/)
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
* Make sure all the required software mentioned above are installed
|
||||||
|
* Clone the repository into your development machine ([*info*](https://help.github.com/desktop/guides/contributing/working-with-your-remote-repository-on-github-or-github-enterprise))
|
||||||
|
* Grab the submodules `git submodule init && git submodule update`
|
||||||
|
* Install the required Node Packages `yarn install`
|
||||||
|
* Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.
|
||||||
|
|
||||||
|
> **Notice**
|
||||||
|
> Gulp must be running at all times while you are working with Radarr client source files.
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
* To build run `sh build.sh`
|
||||||
|
|
||||||
|
**Note:** Windows users must have bash available to do this. If you installed git, you should have a git bash utility that works.
|
||||||
|
|
||||||
|
### Development
|
||||||
|
|
||||||
|
* Open `Radarr.sln` in Visual Studio 2017 or run the build.sh script, if Mono is installed. Alternatively you can use Jetbrains Rider, since it works on all Platforms.
|
||||||
|
* Make sure `NzbDrone.Console` is set as the startup project
|
||||||
|
* Run `build.sh` before running
|
||||||
|
|
||||||
|
## Supporters
|
||||||
|
|
||||||
|
This project would not be possible without the support by these amazing folks. [**Become a sponsor or backer**](https://opencollective.com/radarr) to help us out!
|
||||||
|
|
||||||
|
### Sponsors
|
||||||
|
|
||||||
|
[![Sponsors](https://opencollective.com/radarr/tiers/sponsor.svg)](https://opencollective.com/radarr/order/3851)
|
||||||
|
|
||||||
|
### Flexible Sponsors
|
||||||
|
|
||||||
|
[![Flexible Sponsors](https://opencollective.com/radarr/tiers/flexible-sponsor.svg?avatarHeight=54)](https://opencollective.com/radarr/order/3856)
|
||||||
|
|
||||||
|
### Backers
|
||||||
|
|
||||||
|
[![Backers](https://opencollective.com/radarr/tiers/backer.svg?avatarHeight=48)](https://opencollective.com/radarr/order/3850)
|
||||||
|
|
||||||
|
### JetBrains
|
||||||
|
|
||||||
|
Thank you to [<img src="/Logo/jetbrains.svg" alt="JetBrains" width="32"> JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
|
||||||
|
|
||||||
|
* [<img src="/Logo/resharper.svg" alt="ReSharper" width="32"> ReSharper](http://www.jetbrains.com/resharper/)
|
||||||
|
* [<img src="/Logo/webstorm.svg" alt="WebStorm" width="32"> WebStorm](http://www.jetbrains.com/webstorm/)
|
||||||
|
* [<img src="/Logo/rider.svg" alt="Rider" width="32"> Rider](http://www.jetbrains.com/rider/)
|
||||||
|
* [<img src="/Logo/dottrace.svg" alt="dotTrace" width="32"> dotTrace](http://www.jetbrains.com/dottrace/)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
||||||
|
* Copyright 2010-2019
|
0
jails/sonarr/includes/sonarr.rc
Normal file → Executable file
0
jails/sonarr/includes/sonarr.rc
Normal file → Executable file
@ -1,35 +1,13 @@
|
|||||||
#!/usr/local/bin/bash
|
#!/usr/local/bin/bash
|
||||||
# This file contains the install script for sonarr
|
# This file contains the install script for sonarr
|
||||||
|
|
||||||
iocage exec sonarr mkdir -p /mnt/shows
|
|
||||||
iocage exec sonarr mkdir -p /mnt/fetched
|
|
||||||
|
|
||||||
# Check if dataset for completed download and it parent dataset exist, create if they do not.
|
# Check if dataset for completed download and it parent dataset exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}" ]; then
|
createmount sonarr ${global_dataset_downloads}
|
||||||
echo "Downloads dataset does not exist... Creating... ${global_dataset_downloads}"
|
createmount sonarr ${global_dataset_downloads}/complete /mnt/fetched
|
||||||
zfs create ${global_dataset_downloads}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}/complete" ]; then
|
|
||||||
echo "Completed Downloads dataset does not exist... Creating... ${global_dataset_downloads}/complete"
|
|
||||||
zfs create ${global_dataset_downloads}/complete
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a sonarr /mnt/${global_dataset_downloads}/complete /mnt/fetched nullfs rw 0 0
|
|
||||||
|
|
||||||
# Check if dataset for media library and the dataset for tv shows exist, create if they do not.
|
# Check if dataset for media library and the dataset for tv shows exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_media}" ]; then
|
createmount sonarr ${global_dataset_media}
|
||||||
echo "Media dataset does not exist... Creating... ${global_dataset_media}"
|
createmount sonarr ${global_dataset_media}/shows /mnt/shows
|
||||||
zfs create ${global_dataset_media}
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ ! -d "/mnt/${global_dataset_media}/shows" ]; then
|
|
||||||
echo "TV Shows dataset does not exist... Creating... ${global_dataset_media}/shows"
|
|
||||||
zfs create ${global_dataset_media}/shows
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a sonarr /mnt/${global_dataset_media}/shows /mnt/shows nullfs rw 0 0
|
|
||||||
|
|
||||||
|
|
||||||
iocage exec sonarr ln -s /usr/local/bin/mono /usr/bin/mono
|
iocage exec sonarr ln -s /usr/local/bin/mono /usr/bin/mono
|
||||||
iocage exec sonarr "fetch http://download.sonarr.tv/v2/master/mono/NzbDrone.master.tar.gz -o /usr/local/share"
|
iocage exec sonarr "fetch http://download.sonarr.tv/v2/master/mono/NzbDrone.master.tar.gz -o /usr/local/share"
|
||||||
|
63
jails/sonarr/readme.md
Executable file
63
jails/sonarr/readme.md
Executable file
@ -0,0 +1,63 @@
|
|||||||
|
# Original README from the sonarr github:
|
||||||
|
|
||||||
|
https://github.com/Sonarr/Sonarr
|
||||||
|
|
||||||
|
# Sonarr
|
||||||
|
|
||||||
|
|
||||||
|
Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
|
||||||
|
|
||||||
|
## Major Features Include:
|
||||||
|
|
||||||
|
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
|
||||||
|
* Automatically detects new episodes
|
||||||
|
* Can scan your existing library and download any missing episodes
|
||||||
|
* Can watch for better quality of the episodes you already have and do an automatic upgrade. *eg. from DVD to Blu-Ray*
|
||||||
|
* Automatic failed download handling will try another release if one fails
|
||||||
|
* Manual search so you can pick any release or to see why a release was not downloaded automatically
|
||||||
|
* Fully configurable episode renaming
|
||||||
|
* Full integration with SABnzbd and NZBGet
|
||||||
|
* Full integration with Kodi, Plex (notification, library update, metadata)
|
||||||
|
* Full support for specials and multi-episode releases
|
||||||
|
* And a beautiful UI
|
||||||
|
|
||||||
|
## Configuring Development Environment:
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
* [Visual Studio 2017](https://www.visualstudio.com/vs/)
|
||||||
|
* [Git](https://git-scm.com/downloads)
|
||||||
|
* [NodeJS](https://nodejs.org/en/download/)
|
||||||
|
* [Yarn](https://yarnpkg.com/)
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
* Make sure all the required software mentioned above are installed
|
||||||
|
* Clone the repository into your development machine. [*info*](https://help.github.com/en/articles/working-with-forks)
|
||||||
|
* Grab the submodules `git submodule init && git submodule update`
|
||||||
|
* Install the required Node Packages `yarn`
|
||||||
|
|
||||||
|
### Backend Development
|
||||||
|
|
||||||
|
* Run `yarn build` to build the UI
|
||||||
|
* Open `Sonarr.sln` in Visual Studio
|
||||||
|
* Make sure `NzbDrone.Console` is set as the startup project
|
||||||
|
* Build `NzbDrone.Windows` and `NzbDrone.Mono` projects
|
||||||
|
* Build Solution
|
||||||
|
|
||||||
|
### UI Development
|
||||||
|
|
||||||
|
* Run `yarn watch` to build UI and rebuild automatically when changes are detected
|
||||||
|
* Run Sonarr.Console.exe (or debug in Visual Studio)
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
|
||||||
|
* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html)
|
||||||
|
* Copyright 2010-2019
|
||||||
|
|
||||||
|
### Sponsors
|
||||||
|
|
||||||
|
* [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools
|
||||||
|
* [ReSharper](http://www.jetbrains.com/resharper/)
|
||||||
|
* [TeamCity](http://www.jetbrains.com/teamcity/)
|
67
jails/tautulli/readme.md
Executable file
67
jails/tautulli/readme.md
Executable file
@ -0,0 +1,67 @@
|
|||||||
|
# Original README from the tautulli github:
|
||||||
|
|
||||||
|
https://github.com/Tautulli/Tautulli
|
||||||
|
|
||||||
|
# Tautulli
|
||||||
|
|
||||||
|
A python based web application for monitoring, analytics and notifications for [Plex Media Server](https://plex.tv).
|
||||||
|
|
||||||
|
This project is based on code from [Headphones](https://github.com/rembo10/headphones) and [PlexWatchWeb](https://github.com/ecleese/plexWatchWeb).
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
* Responsive web design viewable on desktop, tablet and mobile web browsers.
|
||||||
|
* Themed to complement Plex/Web.
|
||||||
|
* Easy configuration setup (no separate web server required).
|
||||||
|
* Monitor current Plex Media Server activity.
|
||||||
|
* Fully customizable notifications for stream activity and recently added media.
|
||||||
|
* Top statistics on home page with configurable duration and measurement metric.
|
||||||
|
* Global watching history with search/filtering & dynamic column sorting.
|
||||||
|
* Full user list with general information and comparison stats.
|
||||||
|
* Individual user information including devices IP addresses.
|
||||||
|
* Complete library statistics and media file information.
|
||||||
|
* Rich analytics presented using Highcharts graphing.
|
||||||
|
* Beautiful content information pages.
|
||||||
|
* Full sync list data on all users syncing items from your library.
|
||||||
|
* And many more!!
|
||||||
|
|
||||||
|
## Preview
|
||||||
|
|
||||||
|
* [Full preview gallery available on our website](https://tautulli.com)
|
||||||
|
|
||||||
|
![Tautulli Homepage](https://tautulli.com/images/screenshots/activity-compressed.jpg?v=2)
|
||||||
|
|
||||||
|
## Installation & Support
|
||||||
|
|
||||||
|
[![Python](https://img.shields.io/badge/python-v2.7.17-blue?style=flat-square)](https://python.org/downloads/release/python-2717/)
|
||||||
|
[![Docker Pulls](https://img.shields.io/docker/pulls/tautulli/tautulli?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli)
|
||||||
|
[![Docker Stars](https://img.shields.io/docker/stars/tautulli/tautulli?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli)
|
||||||
|
|
||||||
|
| Status | Branch: `master` | Branch: `beta` | Branch: `nightly` |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| Release | [![Release@master](https://img.shields.io/github/v/release/Tautulli/Tautulli?style=flat-square)](https://github.com/Tautulli/Tautulli/releases/latest) <br> [![Release Date@master](https://img.shields.io/github/release-date/Tautulli/Tautulli?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/releases/latest) | [![Release@beta](https://img.shields.io/github/v/release/Tautulli/Tautulli?include_prereleases&style=flat-square)](https://github.com/Tautulli/Tautulli/releases) <br> [![Commits@nightly](https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/beta?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/commits/beta) | [![Last Commits@nightly](https://img.shields.io/github/last-commit/Tautulli/Tautulli/nightly?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/commits/nightly) <br> [![Commits@nightly](https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/nightly?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/commits/nightly) |
|
||||||
|
| Docker | [![Docker@master](https://img.shields.io/badge/tautulli-tautulli:latest-blue?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli) <br> [![Docker Build@master](https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker%20Branch/master?style=flat-square)](https://github.com/Tautulli/Tautulli/actions?query=branch%3Amaster) | [![Docker@beta](https://img.shields.io/badge/tautulli-tautulli:beta-blue?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli) <br> [![Docker Build@beta](https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker%20Branch/beta?style=flat-square)](https://github.com/Tautulli/Tautulli/actions?query=branch%3Abeta) | [![Docker@nightly](https://img.shields.io/badge/tautulli-tautulli:nightly-blue?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli) <br> [![Docker Build@nightly](https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker%20Branch/nightly?style=flat-square)](https://github.com/Tautulli/Tautulli/actions?query=branch%3Anightly) |
|
||||||
|
|
||||||
|
[![Wiki](https://img.shields.io/badge/github-wiki-black?style=flat-square)](https://github.com/Tautulli/Tautulli-Wiki/wiki)
|
||||||
|
[![Discord](https://img.shields.io/discord/183396325142822912?label=discord&style=flat-square&color=7289DA)](https://tautulli.com/discord)
|
||||||
|
[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/tautulli?label=reddit&style=flat-square&color=FF5700)](https://www.reddit.com/r/Tautulli/)
|
||||||
|
[![Plex Forums](https://img.shields.io/badge/plex%20forums-discussion-E5A00D?style=flat-square)](https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242)
|
||||||
|
|
||||||
|
* Read the [Installation Guides](https://github.com/Tautulli/Tautulli-Wiki/wiki/Installation) for instructions to install Tautulli.
|
||||||
|
* The [Frequently Asked Questions](https://github.com/Tautulli/Tautulli-Wiki/wiki/Frequently-Asked-Questions) in the wiki can help you with common problems.
|
||||||
|
* Support is available on [Discord](https://tautulli.com/discord), [Reddit](https://www.reddit.com/r/Tautulli), or the [Plex Forums](https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242).
|
||||||
|
|
||||||
|
## Issues & Feature Requests
|
||||||
|
|
||||||
|
[![Issues](https://img.shields.io/badge/github-issues-red?style=flat-square)](https://github.com/Tautulli/Tautulli-Issues)
|
||||||
|
[![Feathub](https://img.shields.io/badge/feathub-requests-lightgrey?style=flat-square)](https://feathub.com/Tautulli/Tautulli)
|
||||||
|
|
||||||
|
* Please see the [Issues Repository](https://github.com/Tautulli/Tautulli-Issues).
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[![License](https://img.shields.io/github/license/Tautulli/Tautulli?style=flat-square)](https://github.com/Tautulli/Tautulli/blob/master/LICENSE)
|
||||||
|
|
||||||
|
This is free software under the GPL v3 open source license. Feel free to do with it what you wish, but any modification must be open sourced. A copy of the license is included.
|
||||||
|
|
||||||
|
This software includes Highsoft software libraries which you may freely distribute for non-commercial use. Commerical users must licence this software, for more information visit https://shop.highsoft.com/faq/non-commercial#non-commercial-redistribution.
|
@ -1,36 +1,16 @@
|
|||||||
#!/usr/local/bin/bash
|
#!/usr/local/bin/bash
|
||||||
# This file contains the install script for transmission
|
# This file contains the install script for transmission
|
||||||
|
|
||||||
iocage exec transmission mkdir -p /mnt/downloads
|
|
||||||
iocage exec transmission mkdir -p /mnt/downloads/complete
|
|
||||||
iocage exec transmission mkdir -p /mnt/downloads/incomplete
|
|
||||||
|
|
||||||
# Check if dataset Downloads dataset exist, create if they do not.
|
# Check if dataset Downloads dataset exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}" ]; then
|
createmount transmission ${global_dataset_downloads} /mnt/downloads
|
||||||
echo "Downloads dataset does not exist... Creating... ${global_dataset_downloads}"
|
|
||||||
zfs create ${global_dataset_downloads}
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a transmission /mnt/${global_dataset_downloads} /mnt/downloads nullfs rw 0 0
|
|
||||||
|
|
||||||
# Check if dataset Complete Downloads dataset exist, create if they do not.
|
# Check if dataset Complete Downloads dataset exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}/complete" ]; then
|
createmount transmission ${global_dataset_downloads}/complete /mnt/downloads/complete
|
||||||
echo "Completed Downloads dataset does not exist... Creating... ${global_dataset_downloads}/complete"
|
|
||||||
zfs create ${global_dataset_downloads}/complete
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a transmission /mnt/${global_dataset_downloads}/complete /mnt/downloads/complete nullfs rw 0 0
|
|
||||||
|
|
||||||
# Check if dataset InComplete Downloads dataset exist, create if they do not.
|
# Check if dataset InComplete Downloads dataset exist, create if they do not.
|
||||||
if [ ! -d "/mnt/${global_dataset_downloads}/incomplete" ]; then
|
createmount transmission ${global_dataset_downloads}/incomplete /mnt/downloads/incomplete
|
||||||
echo "Completed Downloads dataset does not exist... Creating... ${global_dataset_downloads}/incomplete"
|
|
||||||
zfs create ${global_dataset_downloads}/incomplete
|
|
||||||
fi
|
|
||||||
|
|
||||||
iocage fstab -a transmission /mnt/${global_dataset_downloads}/incomplete /mnt/downloads/incomplete nullfs rw 0 0
|
|
||||||
|
|
||||||
|
|
||||||
iocage exec transmission mkdir -p /config
|
|
||||||
iocage exec transmission chown -R transmission:transmission /config
|
iocage exec transmission chown -R transmission:transmission /config
|
||||||
iocage exec transmission sysrc "transmission_enable=YES"
|
iocage exec transmission sysrc "transmission_enable=YES"
|
||||||
iocage exec transmission sysrc "transmission_conf_dir=/config"
|
iocage exec transmission sysrc "transmission_conf_dir=/config"
|
||||||
|
81
jails/transmission/readme.md
Executable file
81
jails/transmission/readme.md
Executable file
@ -0,0 +1,81 @@
|
|||||||
|
# Original README from the transmission github:
|
||||||
|
|
||||||
|
https://github.com/transmission/transmission
|
||||||
|
|
||||||
|
# Transmission
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
Transmission is a fast, easy, and free BitTorrent client. It comes in several flavors:
|
||||||
|
* A native Mac OS X GUI application
|
||||||
|
* GTK+ and Qt GUI applications for Linux, BSD, etc.
|
||||||
|
* A headless daemon for servers and routers
|
||||||
|
* A web UI for remote controlling any of the above
|
||||||
|
|
||||||
|
Visit https://transmissionbt.com/ for more information.
|
||||||
|
|
||||||
|
## Command line interface notes
|
||||||
|
|
||||||
|
Transmission is fully supported in transmission-remote, the preferred cli client.
|
||||||
|
|
||||||
|
Three standalone tools to examine, create, and edit .torrent files exist: transmission-show, transmission-create, and transmission-edit, respectively.
|
||||||
|
|
||||||
|
Prior to development of transmission-remote, the standalone client transmission-cli was created. Limited to a single torrent at a time, transmission-cli is deprecated and exists primarily to support older hardware dependent upon it. In almost all instances, transmission-remote should be used instead.
|
||||||
|
|
||||||
|
Different distributions may choose to package any or all of these tools in one or more separate packages.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Transmission has an Xcode project file (Transmission.xcodeproj) for building in Xcode.
|
||||||
|
|
||||||
|
For a more detailed description, and dependencies, visit: https://github.com/transmission/transmission/wiki
|
||||||
|
|
||||||
|
### Building a Transmission release from the command line
|
||||||
|
|
||||||
|
$ tar xf transmission-2.92.tar.xz
|
||||||
|
$ cd transmission-2.92
|
||||||
|
$ mkdir build
|
||||||
|
$ cd build
|
||||||
|
$ cmake ..
|
||||||
|
$ make
|
||||||
|
$ sudo make install
|
||||||
|
|
||||||
|
### Building Transmission from the nightly builds
|
||||||
|
|
||||||
|
Download a tarball from https://build.transmissionbt.com/job/trunk-linux/ and follow the steps from the previous section.
|
||||||
|
|
||||||
|
If you're new to building programs from source code, this is typically easier than building from Git.
|
||||||
|
|
||||||
|
### Building Transmission from Git (first time)
|
||||||
|
|
||||||
|
$ git clone https://github.com/transmission/transmission Transmission
|
||||||
|
$ cd Transmission
|
||||||
|
$ git submodule update --init
|
||||||
|
$ mkdir build
|
||||||
|
$ cd build
|
||||||
|
$ cmake ..
|
||||||
|
$ make
|
||||||
|
$ sudo make install
|
||||||
|
|
||||||
|
### Building Transmission from Git (updating)
|
||||||
|
|
||||||
|
$ cd Transmission/build
|
||||||
|
$ make clean
|
||||||
|
$ git pull --rebase --prune
|
||||||
|
$ git submodule update
|
||||||
|
$ cmake ..
|
||||||
|
$ make
|
||||||
|
$ sudo make install
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
### Code Style
|
||||||
|
|
||||||
|
You would want to setup your editor to make use of uncrustify.cfg and .jsbeautifyrc configuration files located in the root of this repository.
|
||||||
|
|
||||||
|
If for some reason you are unwilling or unable to do so, there is a shell script which you could run either directly or via docker-compose:
|
||||||
|
|
||||||
|
$ ./code_style.sh
|
||||||
|
or
|
||||||
|
$ docker-compose build --pull
|
||||||
|
$ docker-compose run --rm code_style
|
1
wiki/test.md
Normal file
1
wiki/test.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
wiki test placeholder
|
Loading…
Reference in New Issue
Block a user