Compare commits
65 commits
Author | SHA1 | Date | |
---|---|---|---|
b58c283a4b | |||
5805279633 | |||
b61677ebe8 | |||
fc7abd4ba1 | |||
00e96ef7ae | |||
21e2758323 | |||
3d4c3e6e42 | |||
f327088771 | |||
fb578fd670 | |||
ab546d6536 | |||
c842685155 | |||
7241874e5d | |||
41234b34bf | |||
df2d9520ca | |||
31c99cc668 | |||
36023ec566 | |||
0df0cadede | |||
b3f201e87d | |||
fe5b6f72f6 | |||
c5b61fea0b | |||
7a5a811b23 | |||
1171f52445 | |||
c5156c6056 | |||
38e562a3ac | |||
b161b389b4 | |||
8c16f669b8 | |||
9c697514ce | |||
a0e712827d | |||
8612251448 | |||
569325fbe9 | |||
7cea6110cc | |||
c3e43617e4 | |||
afba893623 | |||
3bb5e51b30 | |||
cae20ac477 | |||
eb0cebea4b | |||
494ca23d82 | |||
1107e3ce2d | |||
63d0956eb3 | |||
8a0cb391fe | |||
f947c51a79 | |||
9e4eb6a4b5 | |||
d42eaa9111 | |||
20fb428b1e | |||
1b130315d2 | |||
a863713037 | |||
513bc9b811 | |||
ccc686ae28 | |||
871dfa5675 | |||
4ae2bd5b44 | |||
bff62615fa | |||
4cb1aa0056 | |||
eacd690b18 | |||
c05b1e8d06 | |||
ab56fde2a1 | |||
16e787ec0c | |||
2489e2c209 | |||
34a8ab231f | |||
9446d0280a | |||
fab76db397 | |||
3eb5cfcc1e | |||
dbe38967a5 | |||
a4a0202859 | |||
ca5e677b2d | |||
d997b5423b |
57
.drone.yml
Normal file
|
@ -0,0 +1,57 @@
|
||||||
|
---
|
||||||
|
kind: pipeline
|
||||||
|
type: docker
|
||||||
|
name: default
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
event:
|
||||||
|
include:
|
||||||
|
- push
|
||||||
|
- cron
|
||||||
|
branch:
|
||||||
|
- master
|
||||||
|
|
||||||
|
environment: &default_environment
|
||||||
|
REVISION: ${DRONE_COMMIT_SHA}
|
||||||
|
CREATED: ${DRONE_BUILD_CREATED}
|
||||||
|
SOURCE_URL: ${DRONE_GIT_HTTP_URL}
|
||||||
|
# also change in 'tags' of build docker
|
||||||
|
TS3WEB_VERSION: 2.2.6
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: build docker image
|
||||||
|
image: plugins/docker
|
||||||
|
environment:
|
||||||
|
<<: *default_environment
|
||||||
|
settings:
|
||||||
|
purge: true
|
||||||
|
repo: varakh/ts3web
|
||||||
|
username:
|
||||||
|
from_secret: dockerhub_user
|
||||||
|
password:
|
||||||
|
from_secret: dockerhub_key
|
||||||
|
tags:
|
||||||
|
- latest
|
||||||
|
- 2.2.6
|
||||||
|
|
||||||
|
- name: notify
|
||||||
|
image: drillster/drone-email
|
||||||
|
settings:
|
||||||
|
subject: "Build failed"
|
||||||
|
body: "URL ${DRONE_BUILD_LINK}"
|
||||||
|
host:
|
||||||
|
from_secret: mail_host
|
||||||
|
username:
|
||||||
|
from_secret: mail_user
|
||||||
|
password:
|
||||||
|
from_secret: mail_password
|
||||||
|
from:
|
||||||
|
from_secret: mail_from
|
||||||
|
when:
|
||||||
|
status:
|
||||||
|
- failure
|
||||||
|
---
|
||||||
|
kind: signature
|
||||||
|
hmac: f575a63bd85c4a95593be5e077373216fbd50ad57e6b3d1db56f950e881ed2a5
|
||||||
|
|
||||||
|
...
|
6
.editorconfig
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = true
|
||||||
|
charset = utf-8
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
6
.gitignore
vendored
|
@ -1,12 +1,16 @@
|
||||||
bin/*
|
bin/*
|
||||||
!bin/.gitkeep
|
!bin/.gitkeep
|
||||||
config/env
|
config/env
|
||||||
composer.lock
|
composer.phar
|
||||||
cache/*
|
cache/*
|
||||||
!cache/.gitkeep
|
!cache/.gitkeep
|
||||||
public/images/*
|
public/images/*
|
||||||
!public/images/.gitkeep
|
!public/images/.gitkeep
|
||||||
|
!public/images/flags
|
||||||
|
!public/images/viewer
|
||||||
vendor/
|
vendor/
|
||||||
.idea/
|
.idea/
|
||||||
log/*
|
log/*
|
||||||
!log/.gitkeep
|
!log/.gitkeep
|
||||||
|
data/snapshots/*
|
||||||
|
!data/snapshots/.gitkeep
|
||||||
|
|
127
CHANGELOG.md
Normal file
|
@ -0,0 +1,127 @@
|
||||||
|
# CHANGELOG
|
||||||
|
|
||||||
|
## 2.2.6 - 2023/04/06
|
||||||
|
|
||||||
|
_Quick update for an outdated application to make it more useful for docker setups. Keep in mind that PHP 7.4 which is used by ts3web is still EOL!_
|
||||||
|
|
||||||
|
* Made it possible to use environment variable to define location of bootstrapping `env` file in docker containers (natively, set php-fpm `ENV[]` properly!)
|
||||||
|
* `ENV_DIR`: location of the **PARENT** folder which has the `env` file inside
|
||||||
|
* Falls back to application `$appDir/config/env` file if not set
|
||||||
|
* Added new `env` file variables to easily configure
|
||||||
|
* `log_dir`: location of the log dir, _without trailing slash_
|
||||||
|
* `snapshot_dir` location of the snapshots dir, _without trailing slash_
|
||||||
|
|
||||||
|
## 2.2.5 - 2022/12/17
|
||||||
|
* Updated `Dockerfile` (as long as alpine 3.15 shipping PHP7 is kept updated, `ts3web` docker images are kept)
|
||||||
|
* Updated some symfony dependencies
|
||||||
|
|
||||||
|
## 2.2.4 - 2022/01/19
|
||||||
|
* Updated dependencies
|
||||||
|
* This application will be EOL once PHP7 is not supported anymore
|
||||||
|
|
||||||
|
## 2.2.3 - 2021/01/08
|
||||||
|
|
||||||
|
* Change docker base to alpine
|
||||||
|
|
||||||
|
## 2.2.2 - 2020/03/22
|
||||||
|
|
||||||
|
* Stop auto-sorting tables
|
||||||
|
* Add bandwidth formatter
|
||||||
|
* Check PHP 7.4 compatibility
|
||||||
|
* Increase docker image base to PHP 7.4
|
||||||
|
|
||||||
|
## 2.2.1 - 2019/11/10
|
||||||
|
|
||||||
|
* Use separate JavaScript file to initialize DataTables
|
||||||
|
|
||||||
|
## 2.2.0 - 2019/11/10
|
||||||
|
|
||||||
|
* Add version tag to footer
|
||||||
|
* Add sortable tables
|
||||||
|
* Add search on tables
|
||||||
|
* Increase bootstrap4 theme width
|
||||||
|
* Handle deprecation warnings in Twig
|
||||||
|
* Fix dependency version
|
||||||
|
|
||||||
|
## 2.1.4 - 2019/11/08
|
||||||
|
|
||||||
|
* Use autofocus on username input field instead of the password field
|
||||||
|
* Fill missing cells on incorrect cell count in table views when only partial data is available
|
||||||
|
|
||||||
|
## 2.1.3 - 2019/08/08
|
||||||
|
|
||||||
|
* Fixed false rendering of forms
|
||||||
|
* Fixed channel tree view showing the wrong virtual server after selection
|
||||||
|
* Minor code refactor
|
||||||
|
|
||||||
|
## 2.1.2 - 2019/08/07
|
||||||
|
|
||||||
|
* Minor refactoring
|
||||||
|
* Update documentation
|
||||||
|
|
||||||
|
## 2.1.1 - 2019/08/07
|
||||||
|
|
||||||
|
* Updated translation
|
||||||
|
|
||||||
|
## 2.1.0 - 2019/08/07
|
||||||
|
|
||||||
|
* Fixed file handling on snapshots
|
||||||
|
* Cleaned up template links
|
||||||
|
* Updated documentation
|
||||||
|
* Added application log view
|
||||||
|
* Fixed files view
|
||||||
|
* Added show total used space for files in a channel
|
||||||
|
* Added file delete action
|
||||||
|
* Removed about modal
|
||||||
|
|
||||||
|
## 2.0.0 - 2019/08/06
|
||||||
|
|
||||||
|
* Replace material design with bootstrap4 theme
|
||||||
|
* Add an about modal
|
||||||
|
* Add tree view for online clients
|
||||||
|
* Update deployment and release documentation and examples
|
||||||
|
* Update dependencies and force PHP 7.3
|
||||||
|
|
||||||
|
## 1.2.4 - 2019/01/18
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.2.3 - 2019/01/18
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.2.2 - 2018/09/01
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.2.1 - 2018/06/04
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.2.0 - 2018/06/04
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.1.1 - 2018/05/04
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.1.0 - 2018/05/04
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.0.3 - 2018/04/04
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.0.2 - 2018/04/04
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.0.1 - 2018/04/03
|
||||||
|
|
||||||
|
* No info text
|
||||||
|
|
||||||
|
## 1.0.0 - 2018/04/03
|
||||||
|
|
||||||
|
* No info text
|
85
Dockerfile
Normal file
|
@ -0,0 +1,85 @@
|
||||||
|
FROM alpine:3.15
|
||||||
|
|
||||||
|
LABEL maintainer="Varakh<varakh@varakh.de>"
|
||||||
|
|
||||||
|
ENV APP_HOME=/var/www/html/application \
|
||||||
|
PHP_MEMORY_LIMIT=512M \
|
||||||
|
MAX_UPLOAD=1024M \
|
||||||
|
PHP_MAX_FILE_UPLOAD=200 \
|
||||||
|
PHP_MAX_POST=1024M
|
||||||
|
|
||||||
|
# setup folder structure
|
||||||
|
RUN mkdir -p ${APP_HOME}/data/snapshots && \
|
||||||
|
mkdir -p ${APP_HOME}/log && \
|
||||||
|
touch ${APP_HOME}/log/application.log && \
|
||||||
|
mkdir -p ${APP_HOME}/config
|
||||||
|
|
||||||
|
# entrypoint
|
||||||
|
ADD docker/configure.php /configure.php
|
||||||
|
|
||||||
|
# add upstream application
|
||||||
|
ADD src ${APP_HOME}/src
|
||||||
|
ADD public ${APP_HOME}/public
|
||||||
|
ADD composer.json ${APP_HOME}/composer.json
|
||||||
|
ADD composer.lock ${APP_HOME}/composer.lock
|
||||||
|
ADD data ${APP_HOME}/data
|
||||||
|
ADD config ${APP_HOME}/config
|
||||||
|
|
||||||
|
# install dependencies
|
||||||
|
RUN cp ${APP_HOME}/config/env.example ${APP_HOME}/config/env && \
|
||||||
|
apk add --update --no-cache \
|
||||||
|
bash \
|
||||||
|
nginx \
|
||||||
|
s6 \
|
||||||
|
curl \
|
||||||
|
git \
|
||||||
|
php7 \
|
||||||
|
php7-fpm \
|
||||||
|
php7-cli \
|
||||||
|
php7-intl \
|
||||||
|
php7-curl \
|
||||||
|
php7-json \
|
||||||
|
php7-dom \
|
||||||
|
php7-simplexml \
|
||||||
|
php7-pcntl \
|
||||||
|
php7-posix \
|
||||||
|
php7-mcrypt \
|
||||||
|
php7-session \
|
||||||
|
php7-gd \
|
||||||
|
php7-phar \
|
||||||
|
php7-fileinfo \
|
||||||
|
php7-mbstring \
|
||||||
|
php7-ctype \
|
||||||
|
php7-ldap \
|
||||||
|
php7-openssl \
|
||||||
|
php7-pecl-memcached \
|
||||||
|
memcached \
|
||||||
|
ca-certificates && \
|
||||||
|
rm -rf /var/cache/apk/* && \
|
||||||
|
apk add gnu-libiconv --update-cache --repository http://dl-cdn.alpinelinux.org/alpine/edge/community/ --allow-untrusted && \
|
||||||
|
# set environments/php
|
||||||
|
sed -i "s|;*memory_limit =.*|memory_limit = ${PHP_MEMORY_LIMIT}|i" /etc/php7/php.ini && \
|
||||||
|
sed -i "s|;*upload_max_filesize =.*|upload_max_filesize = ${MAX_UPLOAD}|i" /etc/php7/php.ini && \
|
||||||
|
sed -i "s|;*max_file_uploads =.*|max_file_uploads = ${PHP_MAX_FILE_UPLOAD}|i" /etc/php7/php.ini && \
|
||||||
|
sed -i "s|;*post_max_size =.*|post_max_size = ${PHP_MAX_POST}|i" /etc/php7/php.ini && \
|
||||||
|
# prepare php
|
||||||
|
curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer && \
|
||||||
|
# prepare application
|
||||||
|
cd ${APP_HOME} && composer install && \
|
||||||
|
# clean up and permissions
|
||||||
|
rm -rf /var/cache/apk/* && \
|
||||||
|
chown nobody:nginx -R ${APP_HOME}
|
||||||
|
|
||||||
|
# Add nginx config
|
||||||
|
ADD docker/nginx.conf /etc/nginx/nginx.conf
|
||||||
|
|
||||||
|
# Add required environment variables to php-fpm
|
||||||
|
RUN echo "env[ENV_DIR]=%%%ENV_DIR%%%" >> /etc/php7/php-fpm.d/www.conf
|
||||||
|
|
||||||
|
EXPOSE 80
|
||||||
|
|
||||||
|
# add overlay
|
||||||
|
ADD docker/s6 /etc/s6/
|
||||||
|
|
||||||
|
# expose start
|
||||||
|
CMD /usr/bin/php /configure.php && exec s6-svscan /etc/s6/
|
674
LICENSE.txt
Normal file
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
338
README.md
Executable file → Normal file
|
@ -1,71 +1,172 @@
|
||||||
# README #
|
# README
|
||||||
|
|
||||||
**ts3web** is a webinterface for any TeamSpeak 3 Server used with serverQuery login.
|
[![Build Status](https://drone.myservermanager.com/api/badges/varakh/ts3web/status.svg)](https://drone.myservermanager.com/varakh/ts3web)
|
||||||
|
|
||||||
Most TeamSpeak 3 interfaces are bloated although nearly all configuration can be done entirely in the TeamSpeak 3 Client.
|
ts3web is a free and open-source web interface for TeamSpeak 3 instances.
|
||||||
|
|
||||||
This webinterface aims to be as simple as possible. It does not provide complex features which can be configured within the client. Instead, it only supports features considered useful for a TeamSpeak 3 web interface. **The minimalistic approach is intentional!**
|
The minimalistic approach of this application is intentional.
|
||||||
|
|
||||||
If you like to help (to translate or implement missing features), open an issue before. Then create a pull request. You should use existing code to implement new features. PRs will be merged after a code review.
|
* Docker images available on [https://hub.docker.com/r/varakh/ts3web](https://hub.docker.com/r/varakh/ts3web)
|
||||||
|
* Sources are hosted on [https://git.myservermanager.com/varakh/ts3web](https://git.myservermanager.com/varakh/ts3web)
|
||||||
|
|
||||||
Things you **cannot** do:
|
There are many TeamSpeak 3 web interfaces out. Why should I pick ts3web? Free, simple, stateless, easy to extend,
|
||||||
- Server Groups create, edit
|
standard bootstrap theme.
|
||||||
- Channel Groups create, edit
|
|
||||||
- Channels create, edit
|
|
||||||
- Permissions add, edit, delete (server, channel, client)
|
|
||||||
- File management (create, download, delete)
|
|
||||||
- features which are not *explicitly* supported
|
|
||||||
|
|
||||||
Things you **can** do:
|
The main git repository is hosted at
|
||||||
- view
|
_[https://git.myservermanager.com/varakh/ts3web](https://git.myservermanager.com/varakh/ts3web)_.
|
||||||
- instance and host information
|
Other repositories are mirrors and pull requests, issues, and planning are managed there.
|
||||||
- global log
|
|
||||||
- virtual servers
|
|
||||||
- users online
|
|
||||||
- all known clients
|
|
||||||
- channels
|
|
||||||
- groups
|
|
||||||
- channel groups
|
|
||||||
- files
|
|
||||||
- banlist
|
|
||||||
- complain list
|
|
||||||
- permissions (server, channel, client)
|
|
||||||
- edit
|
|
||||||
- virtual server
|
|
||||||
- instance
|
|
||||||
- delete
|
|
||||||
- bans
|
|
||||||
- complains
|
|
||||||
- virtual servers
|
|
||||||
- clients
|
|
||||||
- server groups
|
|
||||||
- channel groups
|
|
||||||
- other actions
|
|
||||||
- create virtual servers
|
|
||||||
- generate serverQuery password
|
|
||||||
- send message to users, servers, channels
|
|
||||||
- ban a user
|
|
||||||
- kick a user
|
|
||||||
- poke a user
|
|
||||||
- add to server group
|
|
||||||
- remove from server group
|
|
||||||
|
|
||||||
## Install ##
|
Contributions are very welcome!
|
||||||
|
|
||||||
* Clone repository
|
## Limitations
|
||||||
* Install composer
|
|
||||||
* Change directory to project home
|
|
||||||
* Copy `config/env.example` to `config/env` and adjust to your needs
|
|
||||||
* `composer install`
|
|
||||||
|
|
||||||
## Deployment ##
|
TeamSpeak has a detailed interface for permissions and uploading files, therefore the following features are not
|
||||||
* Point your document root to `public/`.
|
supported:
|
||||||
* Example `nginx.conf`:
|
|
||||||
|
|
||||||
|
* uploading files (only viewing and deleting, use the official client for uploading)
|
||||||
|
* editing permissions (only viewing, use the client for editing)
|
||||||
|
|
||||||
|
## READ BEFORE USING
|
||||||
|
|
||||||
|
This web interface makes **heavy use of TeamSpeak 3 server query commands**. Please ensure that you _increase query
|
||||||
|
limits_ and whitelist the requesting IP address to a `whitelist.txt` when in a docker environment (see below).
|
||||||
|
|
||||||
|
Please read the next sections carefully.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
_ts3web_ can be deployed natively or via docker. It's recommended to use docker with docker-compose. Those steps are
|
||||||
|
outlined below.
|
||||||
|
|
||||||
|
### docker-compose
|
||||||
|
|
||||||
|
General remarks:
|
||||||
|
|
||||||
|
* By default, `/var/www/html/application/config/env` is used for bootstrapping necessary configuration, can be set to another parent directory with `ENV_DIR` in docker environment variable, e.g., `ENV_DIR=/data`
|
||||||
|
* By default, `/var/www/html/application/data/snapshots` is used for storing snapshots, path can be changed in the `env` file with `snapshot_dir`
|
||||||
|
* By default, `/var/www/html/application/log` is used for storing and reading logs, path can be changed in the `env` file with `log_dir`
|
||||||
|
* Other `env` configuration values are outlined in the [env.example](./config/env.example) file which is also present in the default docker image.
|
||||||
|
|
||||||
|
It's recommended to use the `network=HOST` option for the docker setup, and it will be the only example in this `README` file.
|
||||||
|
|
||||||
|
Let's create the docker volumes first. You could also use automatically generated ones by the `docker-compose` file, you
|
||||||
|
would need to remove the `external: true` in the `volumes` section of the `docker-compose.yml` then.
|
||||||
|
|
||||||
|
Create the external volumes:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker volume create ts3-vol
|
||||||
|
docker volume create ts3web-vol
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Paste the example `docker-compose.yml` into a file on your machine:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
version: '2.1'
|
||||||
|
networks:
|
||||||
|
teamspeak:
|
||||||
|
external: false
|
||||||
|
|
||||||
|
services:
|
||||||
|
app:
|
||||||
|
container_name: teamspeak_app
|
||||||
|
image: teamspeak:latest
|
||||||
|
volumes:
|
||||||
|
- ts3-vol:/var/ts3server
|
||||||
|
# ports are all public here in the HOST mode example
|
||||||
|
environment:
|
||||||
|
- TS3SERVER_LICENSE=accept
|
||||||
|
- TS3SERVER_IP_WHITELIST=/var/ts3server/whitelist.txt
|
||||||
|
restart: unless-stopped
|
||||||
|
network_mode: "host"
|
||||||
|
|
||||||
|
web:
|
||||||
|
container_name: teamspeak_web
|
||||||
|
image: varakh/ts3web:latest
|
||||||
|
volumes:
|
||||||
|
- ts3web-vol:/data
|
||||||
|
environment:
|
||||||
|
# volume needs to contain the env file!
|
||||||
|
- ENV_DIR=/data
|
||||||
|
ports:
|
||||||
|
- 127.0.0.1:8181:80
|
||||||
|
depends_on:
|
||||||
|
- app
|
||||||
|
restart: unless-stopped
|
||||||
|
networks:
|
||||||
|
- teamspeak
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
ts3-vol:
|
||||||
|
ts3web-vol:
|
||||||
|
```
|
||||||
|
|
||||||
|
Let's populate our docker volumes **before** we start!
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker run -d --rm --name ts3web_creator -v ts3web-vol:/mnt alpine tail -f /dev/null
|
||||||
|
docker exec -it ts3web_creator sh
|
||||||
|
|
||||||
|
# inside the container, edit the env by copying the example to the docker volume mount path at /data/env
|
||||||
|
cp /var/www/html/application/config/env /data/env
|
||||||
|
|
||||||
|
# edit the env file to your liking
|
||||||
|
#
|
||||||
|
# the teamspeak_host should point to your public ip address and must be whitelisted inside the teamspeak server itself
|
||||||
|
vi env
|
||||||
|
|
||||||
|
# create necessary directories and set permissions
|
||||||
|
mkdir -p /data/log
|
||||||
|
touch /data/log/application.log
|
||||||
|
mkdir -p /data/snapshots
|
||||||
|
chown -R 65534:65534 /data
|
||||||
|
|
||||||
|
# exit the container
|
||||||
|
exit
|
||||||
|
|
||||||
|
# on the host system, stop the creator container
|
||||||
|
docker stop ts3web_creator
|
||||||
|
```
|
||||||
|
|
||||||
|
Let's populate the teamspeak container with a proper `whitelist.txt` file. See [ensure that you're whitelisting the IP from which the webinterface will issue commands](#whitelisttextfile).
|
||||||
|
|
||||||
|
```shell
|
||||||
|
docker run -d --rm --name ts3_creator -v ts3-vol:/mnt alpine tail -f /dev/null
|
||||||
|
docker exec -it ts3_creator sh
|
||||||
|
|
||||||
|
# edit the whitelist.txt file at /var/ts3server/whitelist.txt
|
||||||
|
# it should contain the following entries
|
||||||
|
#
|
||||||
|
# 127.0.0.1
|
||||||
|
# ::1
|
||||||
|
# your-public-ip
|
||||||
|
#
|
||||||
|
vi /var/ts3server/whitelist.txt
|
||||||
|
|
||||||
|
# exit the container
|
||||||
|
exit
|
||||||
|
|
||||||
|
# on the host system, stop the creator container
|
||||||
|
docker stop ts3_creator
|
||||||
|
```
|
||||||
|
|
||||||
|
Maybe you like to copy valid license files into the `ts3-vol` docker volume before stopping.
|
||||||
|
|
||||||
|
_Finally_, start the stack with `docker-compose up -d`. Please see the **Reverse proxy** section for a nginx example.
|
||||||
|
|
||||||
|
### Reverse proxy
|
||||||
|
|
||||||
|
Here's an example on how to configure a reverse proxy for the web interface docker container
|
||||||
|
|
||||||
|
```shell
|
||||||
root .../public;
|
root .../public;
|
||||||
index index.php;
|
index index.php;
|
||||||
|
|
||||||
|
# enable and setup if you have a certificate (highly recommended)
|
||||||
|
#ssl on;
|
||||||
|
#ssl_certificate fullchain.pem;
|
||||||
|
#ssl_certificate_key privkey.pem;
|
||||||
|
|
||||||
rewrite_log on;
|
rewrite_log on;
|
||||||
|
|
||||||
location / {
|
location / {
|
||||||
|
@ -84,20 +185,131 @@ location ~ \.php$ {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Upgrade ##
|
## Native application
|
||||||
|
|
||||||
|
**Prerequisite**: `php`, `composer` and probably `php-fpm` installed on the server.
|
||||||
|
|
||||||
|
### Install
|
||||||
|
|
||||||
|
* Clone repository
|
||||||
|
* Change directory to project home
|
||||||
|
* Execute `composer install`
|
||||||
|
* `composer install`
|
||||||
|
* Do the configuration by coping the `env.example` file (see information above)
|
||||||
|
* Use a web server _or_ run directly via the embedded PHP server: `php -S localhost:8080 -t public public/index.php`.
|
||||||
|
* Point your browser to [localhost:8080](http://localhost:8080)
|
||||||
|
* Apply any [whitelist.txt](#whitelist-text-file) changes if you configured `teamspeak_host` differently
|
||||||
|
than `localhost`
|
||||||
|
|
||||||
|
### Upgrade
|
||||||
|
|
||||||
* Change directory to project home
|
* Change directory to project home
|
||||||
* `git pull`
|
* `git pull`
|
||||||
* `composer update`
|
* `composer update`
|
||||||
|
|
||||||
## Developers ##
|
## Troubleshooting / F.A.Q
|
||||||
* start server with `php -S localhost:8080 -t public public/index.php`
|
|
||||||
* point browser to [localhost:8080](http://localhost:8080) to have a preview
|
|
||||||
|
|
||||||
## Translations ##
|
<a name="flood"></a>
|
||||||
- This app uses Symfony Translator. It's bootstrapped in `Util\BootstrapHelper` and locales are placed under `data/locale/`. Adjust to your needs or help translating.
|
### How to overcome server query limit?
|
||||||
- Form fields (name/id should be the same) are also translated. For a field named `content` or `ConT enT` translate `form_field_content`.
|
|
||||||
|
|
||||||
|
You might get one of these messages:
|
||||||
|
|
||||||
## Theme ##
|
> I always get `flood client` message when clicking anywhere in the web interface.
|
||||||
Themes can be chosen in the `env` file by editing the `theme` variable. Templates are mapped to the corresponding view folder in `src/View/<themeName>`. `.css`, `.js` and other style files like `.ttf` or `.woff2` for fonts should be placed in `public/theme/<themeName>` and accessed accordingly. See an example in `src/View/material/layout/header.twig`.
|
|
||||||
|
The web UI uses query commands _a lot_! When your instance is up and running, you should be able to change the following
|
||||||
|
setting, e.g. directly in your database (MySQL or sqlite).
|
||||||
|
|
||||||
|
```ini
|
||||||
|
serverinstance_serverquery_flood_commands = 9999
|
||||||
|
serverinstance_serverquery_max_connections_per_ip = 999
|
||||||
|
serverinstance_serverquery_flood_time = 1
|
||||||
|
```
|
||||||
|
|
||||||
|
<a name="whitelist"></a>
|
||||||
|
> I always get `TSException: Error: host isn't a ts3 instance!` when selecting a server.
|
||||||
|
|
||||||
|
You're probably on a docker environment and the TeamSpeak server is queried through the web UI which
|
||||||
|
resides behind a web server, so the TeamSpeak server thinks that the _remote web server IP address_ invokes the query
|
||||||
|
commands and thus blacklists it.
|
||||||
|
|
||||||
|
You need define an exception for you server's IP in a [`whitelist.txt`](#whitelisttextfile) file and include it in
|
||||||
|
your TeamSpeak application.
|
||||||
|
|
||||||
|
You can also add the desired IP to `query_ip_allowlist.txt` and `query_ip_whitelist.txt` within the TeamSpeak 3 Server
|
||||||
|
data directory.
|
||||||
|
|
||||||
|
<a name="dockerperms"></a>
|
||||||
|
### I always get `no write permissions` or something similar when trying to save snapshots or when a log entry is created.
|
||||||
|
|
||||||
|
This probably happens when you're in the docker setup. Ensure that host binds have permissions set up properly and also files inside any
|
||||||
|
docker volume has the correct permissions. The user which is used in the docker container is `nobody` with id `65534`.
|
||||||
|
|
||||||
|
Change owner permissions recursively with `chown -R 65534:65534 /path/to/dir`.
|
||||||
|
|
||||||
|
<a name="whitelisttextfile"></a>
|
||||||
|
### What's a whitelist.txt and why do I need it?
|
||||||
|
|
||||||
|
The following illustrates a valid `whitelist.txt` file which can be used for the above `docker-compose` setups. You need
|
||||||
|
to replace `your-public-ip` with the TeamSpeak's public IP address if required or remove the fixed internal docker IP if
|
||||||
|
you're on 'host' mode.
|
||||||
|
|
||||||
|
```
|
||||||
|
127.0.0.1
|
||||||
|
::1
|
||||||
|
10.5.0.5
|
||||||
|
your-public-ip
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
Contributions are welcome!
|
||||||
|
|
||||||
|
### Release
|
||||||
|
|
||||||
|
* Set a date in the `CHANGELOG.md` file
|
||||||
|
* Remove `SNAPSHOT` from the version in `Constants.php`
|
||||||
|
* Build the docker image from the project
|
||||||
|
* if necessary, add GitHub access token to let composer pull dependencies within the image correctly:
|
||||||
|
add `&& composer config --global --auth github-oauth.github.com <token> \` before the `composer install` command,
|
||||||
|
where `<token>` can be retrieved from [GitHub settings](https://github.com/settings/tokens)
|
||||||
|
* execute `sudo docker build --no-cache -t varakh/ts3web:latest .` to build
|
||||||
|
* publish it
|
||||||
|
* Tag the release git commit and create a new release in the VCS web interface
|
||||||
|
|
||||||
|
### Prepare next development cycle
|
||||||
|
|
||||||
|
1. Branch from `master` to `release/prepare-newVersionNumber`
|
||||||
|
2. Add `-SNAPSHOT` to the version in `Constants.php` and increase it
|
||||||
|
3. Merge this branch to `patch` or/and `dev` respectively
|
||||||
|
4. Don't forget to clean up all created branches
|
||||||
|
|
||||||
|
### Helpers
|
||||||
|
|
||||||
|
Attributes can be defined when including `table`, `keyvalues` and `form` templates of twig. This helps to generate
|
||||||
|
tables and forms without the need to specify all attributes.
|
||||||
|
|
||||||
|
```
|
||||||
|
hiddenDependingOnAttribute // hides a row depending on a value in a table
|
||||||
|
hiddenColumns // hides an entire column depending on a key in a table
|
||||||
|
links // generates a link for a specific cell in a table or keyvalue
|
||||||
|
additional_links // generates extra columns in a table
|
||||||
|
filters // applies filters depending on a key in a table or key value view
|
||||||
|
attributesEditable // define editable attributes in the key value view
|
||||||
|
fields // define fields for a form
|
||||||
|
```
|
||||||
|
|
||||||
|
See example usage in the folder `View/bootstrap4`.
|
||||||
|
|
||||||
|
### Translations
|
||||||
|
|
||||||
|
- This app uses Symfony Translator. It's bootstrapped in `Util\BootstrapHelper` and locales are placed
|
||||||
|
under `data/locale/` and the data table `.json` file, e.g. `en_dataTable.json`. Adjust to your needs or help
|
||||||
|
translating.
|
||||||
|
- Form fields (name/id should be the same) are also translated. For a field named `content` or `ConT enT`
|
||||||
|
translate `form_field_content`.
|
||||||
|
|
||||||
|
### Theme
|
||||||
|
|
||||||
|
Themes can be chosen in the `env` file by editing the `theme` variable. Templates are mapped to the corresponding view
|
||||||
|
folder in `src/View/<themeName>`. `.css`, `.js` and other style files like `.ttf` or `.woff2` for fonts should be placed
|
||||||
|
in `public/theme/<themeName>` and accessed accordingly. See an example in `src/View/boostrap4/layout.twig`.
|
||||||
|
|
|
@ -1,19 +1,22 @@
|
||||||
{
|
{
|
||||||
"require": {
|
"require": {
|
||||||
"slim/slim": "^3.0",
|
"php": "^7.4",
|
||||||
"monolog/monolog": "^1.18",
|
"slim/slim": "3.12.2",
|
||||||
"slim/twig-view": "^2.1",
|
"monolog/monolog": "1.25.1",
|
||||||
"slim/flash": "^0.1.0",
|
"slim/twig-view": "2.5.0",
|
||||||
"wixel/gump": "^1.3",
|
"slim/flash": "0.1.0",
|
||||||
"symfony/translation": "^3.1",
|
"wixel/gump": "1.5.7",
|
||||||
"symfony/twig-bridge": "^3.1",
|
"symfony/translation": "3.4.33",
|
||||||
"symfony/yaml": "*",
|
"symfony/twig-bridge": "3.4.33",
|
||||||
"vlucas/phpdotenv": "^2.3",
|
"symfony/yaml": "4.3.6",
|
||||||
|
"vlucas/phpdotenv": "2.6.1",
|
||||||
"jeremykendall/slim-auth": "dev-slim-3.x",
|
"jeremykendall/slim-auth": "dev-slim-3.x",
|
||||||
"phpmailer/phpmailer": "^5.2",
|
"par0noid/ts3admin": "1.0.2.5",
|
||||||
"illuminate/pagination": "^5.5",
|
"nesbot/carbon": "2.26.0",
|
||||||
"par0noid/ts3admin": "^1.0",
|
"bryanjhv/slim-session": "3.6.2",
|
||||||
"planetteamspeak/ts3-php-framework": "^1.1"
|
"symfony/filesystem": "4.3.6",
|
||||||
|
"symfony/finder": "4.3.6",
|
||||||
|
"planetteamspeak/ts3-php-framework": "1.1.33"
|
||||||
},
|
},
|
||||||
"config": {
|
"config": {
|
||||||
"bin-dir": "bin/"
|
"bin-dir": "bin/"
|
||||||
|
@ -25,5 +28,7 @@
|
||||||
"data/",
|
"data/",
|
||||||
"vendor/"
|
"vendor/"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"require-dev": {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
2110
composer.lock
generated
Normal file
|
@ -28,23 +28,35 @@ class ACL extends \Zend\Permissions\Acl\Acl
|
||||||
'/instance',
|
'/instance',
|
||||||
'/instance/edit',
|
'/instance/edit',
|
||||||
|
|
||||||
'/logs',
|
'/logs[/{sid}]',
|
||||||
|
|
||||||
'/servers',
|
'/servers',
|
||||||
'/servers/create',
|
'/servers/create',
|
||||||
'/servers/{sid}',
|
'/servers/{sid}',
|
||||||
|
'/servers/select/{sid}',
|
||||||
|
'/servers/deselect',
|
||||||
'/servers/delete/{sid}',
|
'/servers/delete/{sid}',
|
||||||
'/servers/start/{sid}',
|
'/servers/start/{sid}',
|
||||||
'/servers/stop/{sid}',
|
'/servers/stop/{sid}',
|
||||||
'/servers/send/{sid}',
|
'/servers/send/{sid}',
|
||||||
'/servers/edit/{sid}',
|
'/servers/edit/{sid}',
|
||||||
|
|
||||||
|
'/snapshots/{sid}',
|
||||||
|
'/snapshots/create/{sid}',
|
||||||
|
'/snapshots/deploy/{sid}/{name}',
|
||||||
|
'/snapshots/delete/{sid}/{name}',
|
||||||
|
|
||||||
|
'/tokens/{sid}',
|
||||||
|
'/tokens/add/{sid}',
|
||||||
|
'/tokens/delete/{sid}/{token}',
|
||||||
|
|
||||||
'/online/{sid}',
|
'/online/{sid}',
|
||||||
'/online/{sid}/{clid}',
|
'/online/{sid}/{clid}',
|
||||||
'/online/poke/{sid}/{clid}',
|
'/online/poke/{sid}/{clid}',
|
||||||
'/online/kick/{sid}/{clid}',
|
'/online/kick/{sid}/{clid}',
|
||||||
'/online/ban/{sid}/{clid}',
|
'/online/ban/{sid}/{clid}',
|
||||||
'/online/send/{sid}/{clid}',
|
'/online/send/{sid}/{clid}',
|
||||||
|
'/online/move/{sid}/{clid}',
|
||||||
|
|
||||||
'/clients/{sid}',
|
'/clients/{sid}',
|
||||||
'/clients/{sid}/{cldbid}',
|
'/clients/{sid}/{cldbid}',
|
||||||
|
@ -53,24 +65,36 @@ class ACL extends \Zend\Permissions\Acl\Acl
|
||||||
'/clients/send/{sid}/{cldbid}',
|
'/clients/send/{sid}/{cldbid}',
|
||||||
|
|
||||||
'/channels/{sid}',
|
'/channels/{sid}',
|
||||||
|
'/channels/create/{sid}',
|
||||||
'/channels/{sid}/{cid}',
|
'/channels/{sid}/{cid}',
|
||||||
|
'/channels/edit/{sid}/{cid}',
|
||||||
'/channels/delete/{sid}/{cid}',
|
'/channels/delete/{sid}/{cid}',
|
||||||
'/channels/send/{sid}/{cid}',
|
'/channels/send/{sid}/{cid}',
|
||||||
|
'/channels/files/delete/{sid}/{cid}',
|
||||||
|
|
||||||
'/groups/{sid}',
|
'/groups/{sid}',
|
||||||
'/groups/{sid}/{sgid}',
|
|
||||||
'/groups/delete/{sid}/{sgid}',
|
'/servergroups/{sid}/{sgid}',
|
||||||
'/groups/remove/{sid}/{sgid}/{cldbid}',
|
'/servergroups/create/{sid}',
|
||||||
'/groups/add/{sid}/{sgid}',
|
'/servergroups/delete/{sid}/{sgid}',
|
||||||
|
'/servergroups/rename/{sid}/{sgid}',
|
||||||
|
'/servergroups/remove/{sid}/{sgid}/{cldbid}',
|
||||||
|
'/servergroups/add/{sid}/{sgid}',
|
||||||
|
|
||||||
'/channelgroups/{sid}/{cgid}',
|
'/channelgroups/{sid}/{cgid}',
|
||||||
|
'/channelgroups/create/{sid}',
|
||||||
'/channelgroups/delete/{sid}/{cgid}',
|
'/channelgroups/delete/{sid}/{cgid}',
|
||||||
|
'/channelgroups/rename/{sid}/{cgid}',
|
||||||
|
|
||||||
'/bans/{sid}',
|
'/bans/{sid}',
|
||||||
'/bans/delete/{sid}/{banId}',
|
'/bans/delete/{sid}/{banId}',
|
||||||
|
|
||||||
'/complains/{sid}',
|
'/complains/{sid}',
|
||||||
'/complains/delete/{sid}/{tcldbid}',
|
'/complains/delete/{sid}/{tcldbid}',
|
||||||
|
|
||||||
|
'/passwords/{sid}',
|
||||||
|
'/passwords/add/{sid}',
|
||||||
|
'/passwords/delete/{sid}',
|
||||||
];
|
];
|
||||||
|
|
||||||
const ACL_DEFAULT_ALLOWS = [
|
const ACL_DEFAULT_ALLOWS = [
|
||||||
|
|
46
config/Constants.php
Normal file
|
@ -0,0 +1,46 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class Constants
|
||||||
|
*/
|
||||||
|
class Constants
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Years tag
|
||||||
|
*/
|
||||||
|
const YEARS = '2020-2023';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Version tag
|
||||||
|
*/
|
||||||
|
const VERSION = '2.2.6';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return constant by its class name
|
||||||
|
*
|
||||||
|
* @param $value
|
||||||
|
* @return string|null
|
||||||
|
* @throws ReflectionException
|
||||||
|
*/
|
||||||
|
public static function get($value)
|
||||||
|
{
|
||||||
|
$constants = self::getConstants();
|
||||||
|
if (!array_key_exists($value, $constants)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $constants[$value];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets all constants
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* @throws ReflectionException
|
||||||
|
*/
|
||||||
|
private static function getConstants()
|
||||||
|
{
|
||||||
|
$oClass = new ReflectionClass(__CLASS__);
|
||||||
|
return $oClass->getConstants();
|
||||||
|
}
|
||||||
|
}
|
104
config/EnvConstants.php
Normal file
|
@ -0,0 +1,104 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class EnvConstants
|
||||||
|
*/
|
||||||
|
class EnvConstants
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Example env file
|
||||||
|
*/
|
||||||
|
const FILE_NAME_EXAMPLE_ENV = "env.example";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Custom env file
|
||||||
|
*/
|
||||||
|
const FILE_NAME_ENV = "env";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The path to the env file
|
||||||
|
*/
|
||||||
|
const ENV_DIR = "ENV_DIR";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The path to the logs directory
|
||||||
|
*/
|
||||||
|
const LOG_DIR = "log_dir";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The path to the snapshots directory
|
||||||
|
*/
|
||||||
|
const SNAPSHOT_DIR = "snapshot_dir";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Site title
|
||||||
|
*/
|
||||||
|
const SITE_TITLE = "site_title";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Site language
|
||||||
|
*/
|
||||||
|
const SITE_LANGUAGE = "site_language";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Site date format
|
||||||
|
*/
|
||||||
|
const SITE_DATE_FORMAT = "site_date_format";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Theme
|
||||||
|
*/
|
||||||
|
const THEME = "theme";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cache
|
||||||
|
*/
|
||||||
|
const THEME_CACHE = "theme_cache";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TeamSpeak host
|
||||||
|
*/
|
||||||
|
const TEAMSPEAK_HOST = "teamspeak_host";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TeamSpeak query port
|
||||||
|
*/
|
||||||
|
const TEAMSPEAK_QUERY_PORT = "teamspeak_query_port";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TeamSpeak default user
|
||||||
|
*/
|
||||||
|
const TEAMSPEAK_USER = "teamspeak_user";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TeamSpeak log lines
|
||||||
|
*/
|
||||||
|
const TEAMSPEAK_LOG_LINES = "teamspeak_log_lines";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Log name
|
||||||
|
*/
|
||||||
|
const LOG_NAME = "log_name";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Log level
|
||||||
|
*/
|
||||||
|
const LOG_LEVEL = "log_level";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Required attributes
|
||||||
|
*/
|
||||||
|
const ENV_REQUIRED = [
|
||||||
|
EnvConstants::SITE_TITLE,
|
||||||
|
EnvConstants::SITE_LANGUAGE,
|
||||||
|
EnvConstants::SITE_DATE_FORMAT,
|
||||||
|
EnvConstants::THEME,
|
||||||
|
EnvConstants::THEME_CACHE,
|
||||||
|
EnvConstants::TEAMSPEAK_HOST,
|
||||||
|
EnvConstants::TEAMSPEAK_QUERY_PORT,
|
||||||
|
EnvConstants::TEAMSPEAK_USER,
|
||||||
|
EnvConstants::TEAMSPEAK_LOG_LINES,
|
||||||
|
EnvConstants::LOG_NAME,
|
||||||
|
EnvConstants::LOG_LEVEL
|
||||||
|
];
|
||||||
|
}
|
|
@ -1,19 +1,23 @@
|
||||||
# site
|
# site
|
||||||
site_title="Teamspeak 3 Web"
|
site_title="Teamspeak 3 Web"
|
||||||
site_url="http://localhost:8080"
|
|
||||||
site_index="/servers" # values: "/", "..."
|
|
||||||
site_language="en" # values: each yml you specified in data/locale/
|
site_language="en" # values: each yml you specified in data/locale/
|
||||||
site_date_format="d.m.Y H:i:s" # values: all possible for Date::class
|
site_date_format="d.m.Y H:i:s" # values: all possible for Date::class
|
||||||
|
|
||||||
# theme
|
# theme
|
||||||
theme="material" # values: material (foldernames are used to determine theme in src/View/)
|
theme="bootstrap4" # values: bootstrap4 (foldernames are used to determine theme in src/View/)
|
||||||
theme_cache=false # values: true|false (cache view/twig. makes it faster, disable for debug)
|
theme_cache=false # values: true|false (cache view/twig. makes it faster, disable for debug)
|
||||||
|
|
||||||
# teamspeak
|
# teamspeak
|
||||||
teamspeak_default_host="localhost"
|
teamspeak_host="app" # 'localhost' or 'name_of_docker_container|name_of_the_docker-compose_service' if running locally
|
||||||
teamspeak_default_query_port=10011
|
teamspeak_query_port=10011
|
||||||
teamspeak_default_user="serveradmin"
|
teamspeak_user="serveradmin"
|
||||||
|
teamspeak_tree_view="true" # show a tree view in the details of online clients if a server has been selected
|
||||||
|
teamspeak_log_lines=100 # show this amount of latest log lines
|
||||||
|
|
||||||
# log
|
# log
|
||||||
log_name="app" # values: all strings
|
log_dir=/var/www/html/application/log
|
||||||
|
log_name="ts3web" # values: all strings
|
||||||
log_level="INFO" # values: DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
|
log_level="INFO" # values: DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY
|
||||||
|
|
||||||
|
# snapshots
|
||||||
|
snapshot_dir=/var/www/html/application/data/snapshots
|
||||||
|
|
|
@ -56,7 +56,7 @@ $app->get('/profile/credentials', ProfileCredentialsChangeAction::class);
|
||||||
$container[LogsAction::class] = function ($container) {
|
$container[LogsAction::class] = function ($container) {
|
||||||
return new LogsAction($container);
|
return new LogsAction($container);
|
||||||
};
|
};
|
||||||
$app->get('/logs', LogsAction::class);
|
$app->get('/logs[/{sid}]', LogsAction::class);
|
||||||
|
|
||||||
// instance
|
// instance
|
||||||
$container[InstanceAction::class] = function ($container) {
|
$container[InstanceAction::class] = function ($container) {
|
||||||
|
@ -80,6 +80,16 @@ $container[ServerCreateAction::class] = function ($container) {
|
||||||
};
|
};
|
||||||
$app->post('/servers/create', ServerCreateAction::class);
|
$app->post('/servers/create', ServerCreateAction::class);
|
||||||
|
|
||||||
|
$container[ServerSelectAction::class] = function ($container) {
|
||||||
|
return new ServerSelectAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/servers/select/{sid}', ServerSelectAction::class);
|
||||||
|
|
||||||
|
$container[ServerDeselectAction::class] = function ($container) {
|
||||||
|
return new ServerDeselectAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/servers/deselect', ServerDeselectAction::class);
|
||||||
|
|
||||||
$container[ServerDeleteAction::class] = function ($container) {
|
$container[ServerDeleteAction::class] = function ($container) {
|
||||||
return new ServerDeleteAction($container);
|
return new ServerDeleteAction($container);
|
||||||
};
|
};
|
||||||
|
@ -165,34 +175,49 @@ $app->post('/online/ban/{sid}/{clid}', OnlineBanAction::class);
|
||||||
$container[OnlineSendAction::class] = function ($container) {
|
$container[OnlineSendAction::class] = function ($container) {
|
||||||
return new OnlineSendAction($container);
|
return new OnlineSendAction($container);
|
||||||
};
|
};
|
||||||
|
|
||||||
$app->post('/online/send/{sid}/{clid}', OnlineSendAction::class);
|
$app->post('/online/send/{sid}/{clid}', OnlineSendAction::class);
|
||||||
|
|
||||||
|
$container[OnlineMoveAction::class] = function ($container) {
|
||||||
|
return new OnlineMoveAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/online/move/{sid}/{clid}', OnlineMoveAction::class);
|
||||||
|
|
||||||
// group
|
// group
|
||||||
$container[GroupsAction::class] = function ($container) {
|
$container[GroupsAction::class] = function ($container) {
|
||||||
return new GroupsAction($container);
|
return new GroupsAction($container);
|
||||||
};
|
};
|
||||||
$app->get('/groups/{sid}', GroupsAction::class);
|
$app->get('/groups/{sid}', GroupsAction::class);
|
||||||
|
|
||||||
$container[GroupInfoAction::class] = function ($container) {
|
// server group
|
||||||
return new GroupInfoAction($container);
|
$container[ServerGroupInfoAction::class] = function ($container) {
|
||||||
|
return new ServerGroupInfoAction($container);
|
||||||
};
|
};
|
||||||
$app->get('/groups/{sid}/{sgid}', GroupInfoAction::class);
|
$app->get('/servergroups/{sid}/{sgid}', ServerGroupInfoAction::class);
|
||||||
|
|
||||||
$container[GroupDeleteAction::class] = function ($container) {
|
$container[ServerGroupDeleteAction::class] = function ($container) {
|
||||||
return new GroupDeleteAction($container);
|
return new ServerGroupDeleteAction($container);
|
||||||
};
|
};
|
||||||
$app->get('/groups/delete/{sid}/{sgid}', GroupDeleteAction::class);
|
$app->get('/servergroups/delete/{sid}/{sgid}', ServerGroupDeleteAction::class);
|
||||||
|
|
||||||
$container[GroupRemoveAction::class] = function ($container) {
|
$container[ServerGroupRemoveAction::class] = function ($container) {
|
||||||
return new GroupRemoveAction($container);
|
return new ServerGroupRemoveAction($container);
|
||||||
};
|
};
|
||||||
$app->get('/groups/remove/{sid}/{sgid}/{cldbid}', GroupRemoveAction::class);
|
$app->get('/servergroups/remove/{sid}/{sgid}/{cldbid}', ServerGroupRemoveAction::class);
|
||||||
|
|
||||||
$container[GroupAddAction::class] = function ($container) {
|
$container[ServerGroupAddAction::class] = function ($container) {
|
||||||
return new GroupAddAction($container);
|
return new ServerGroupAddAction($container);
|
||||||
};
|
};
|
||||||
$app->post('/groups/add/{sid}/{sgid}', GroupAddAction::class);
|
$app->post('/servergroups/add/{sid}/{sgid}', ServerGroupAddAction::class);
|
||||||
|
|
||||||
|
$container[ServerGroupRenameAction::class] = function ($container) {
|
||||||
|
return new ServerGroupRenameAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/servergroups/rename/{sid}/{sgid}', ServerGroupRenameAction::class);
|
||||||
|
|
||||||
|
$container[ServerGroupCreateAction::class] = function ($container) {
|
||||||
|
return new ServerGroupCreateAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/servergroups/create/{sid}', ServerGroupCreateAction::class);
|
||||||
|
|
||||||
|
|
||||||
// channel group
|
// channel group
|
||||||
|
@ -206,6 +231,16 @@ $container[ChannelGroupDeleteAction::class] = function ($container) {
|
||||||
};
|
};
|
||||||
$app->get('/channelgroups/delete/{sid}/{cgid}', ChannelGroupDeleteAction::class);
|
$app->get('/channelgroups/delete/{sid}/{cgid}', ChannelGroupDeleteAction::class);
|
||||||
|
|
||||||
|
$container[ChannelGroupRenameAction::class] = function ($container) {
|
||||||
|
return new ChannelGroupRenameAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/channelgroups/rename/{sid}/{cgid}', ChannelGroupRenameAction::class);
|
||||||
|
|
||||||
|
$container[ChannelGroupCreateAction::class] = function ($container) {
|
||||||
|
return new ChannelGroupCreateAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/channelgroups/create/{sid}', ChannelGroupCreateAction::class);
|
||||||
|
|
||||||
// ban
|
// ban
|
||||||
$container[BansAction::class] = function ($container) {
|
$container[BansAction::class] = function ($container) {
|
||||||
return new BansAction($container);
|
return new BansAction($container);
|
||||||
|
@ -239,6 +274,16 @@ $container[ChannelInfoAction::class] = function ($container) {
|
||||||
};
|
};
|
||||||
$app->get('/channels/{sid}/{cid}', ChannelInfoAction::class);
|
$app->get('/channels/{sid}/{cid}', ChannelInfoAction::class);
|
||||||
|
|
||||||
|
$container[ChannelCreateAction::class] = function ($container) {
|
||||||
|
return new ChannelCreateAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/channels/create/{sid}', ChannelCreateAction::class);
|
||||||
|
|
||||||
|
$container[ChannelEditAction::class] = function ($container) {
|
||||||
|
return new ChannelEditAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/channels/edit/{sid}/{cid}', ChannelEditAction::class);
|
||||||
|
|
||||||
$container[ChannelDeleteAction::class] = function ($container) {
|
$container[ChannelDeleteAction::class] = function ($container) {
|
||||||
return new ChannelDeleteAction($container);
|
return new ChannelDeleteAction($container);
|
||||||
};
|
};
|
||||||
|
@ -248,3 +293,61 @@ $container[ChannelSendAction::class] = function ($container) {
|
||||||
return new ChannelSendAction($container);
|
return new ChannelSendAction($container);
|
||||||
};
|
};
|
||||||
$app->post('/channels/send/{sid}/{cid}', ChannelSendAction::class);
|
$app->post('/channels/send/{sid}/{cid}', ChannelSendAction::class);
|
||||||
|
|
||||||
|
$container[ChannelFilesDeleteAction::class] = function ($container) {
|
||||||
|
return new ChannelFilesDeleteAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/channels/files/delete/{sid}/{cid}', ChannelFilesDeleteAction::class);
|
||||||
|
|
||||||
|
// tokens
|
||||||
|
$container[TokensAction::class] = function ($container) {
|
||||||
|
return new TokensAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/tokens/{sid}', TokensAction::class);
|
||||||
|
|
||||||
|
$container[TokenAddAction::class] = function ($container) {
|
||||||
|
return new TokenAddAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/tokens/add/{sid}', TokenAddAction::class);
|
||||||
|
|
||||||
|
$container[TokenDeleteAction::class] = function ($container) {
|
||||||
|
return new TokenDeleteAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/tokens/delete/{sid}/{token}', TokenDeleteAction::class);
|
||||||
|
|
||||||
|
// snapshots
|
||||||
|
$container[SnapshotsAction::class] = function ($container) {
|
||||||
|
return new SnapshotsAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/snapshots/{sid}', SnapshotsAction::class);
|
||||||
|
|
||||||
|
$container[SnapshotCreateAction::class] = function ($container) {
|
||||||
|
return new SnapshotCreateAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/snapshots/create/{sid}', SnapshotCreateAction::class);
|
||||||
|
|
||||||
|
$container[SnapshotDeployAction::class] = function ($container) {
|
||||||
|
return new SnapshotDeployAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/snapshots/deploy/{sid}/{name}', SnapshotDeployAction::class);
|
||||||
|
|
||||||
|
$container[SnapshotDeleteAction::class] = function ($container) {
|
||||||
|
return new SnapshotDeleteAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/snapshots/delete/{sid}/{name}', SnapshotDeleteAction::class);
|
||||||
|
|
||||||
|
// passwords
|
||||||
|
$container[PasswordsAction::class] = function ($container) {
|
||||||
|
return new PasswordsAction($container);
|
||||||
|
};
|
||||||
|
$app->get('/passwords/{sid}', PasswordsAction::class);
|
||||||
|
|
||||||
|
$container[PasswordAddAction::class] = function ($container) {
|
||||||
|
return new PasswordAddAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/passwords/add/{sid}', PasswordAddAction::class);
|
||||||
|
|
||||||
|
$container[PasswordDeleteAction::class] = function ($container) {
|
||||||
|
return new PasswordDeleteAction($container);
|
||||||
|
};
|
||||||
|
$app->post('/passwords/delete/{sid}', PasswordDeleteAction::class);
|
||||||
|
|
|
@ -8,16 +8,21 @@ error.500.content: "Internal application error."
|
||||||
error.500.title: "500"
|
error.500.title: "500"
|
||||||
login.flash.success: "Logged in as %username% successfully."
|
login.flash.success: "Logged in as %username% successfully."
|
||||||
login.flash.wrong_credentials: "Cannot login. Wrong credentials."
|
login.flash.wrong_credentials: "Cannot login. Wrong credentials."
|
||||||
login.form.button: "Login"
|
login.form.button: "Sign in"
|
||||||
|
login.form.host: "Host"
|
||||||
|
login.form.username: "User"
|
||||||
|
login.form.password: "Password"
|
||||||
login.form.password.placeholder: "Password"
|
login.form.password.placeholder: "Password"
|
||||||
login.form.username.placeholder: "Username"
|
login.form.username.placeholder: "Username"
|
||||||
log.internal.application.error: "Internal application error."
|
log.internal.application.error: "Internal application error."
|
||||||
login.title: "Login"
|
login.title: "Please login"
|
||||||
logout.flash.success: "Logged out successfully."
|
logout.flash.success: "Logged out successfully."
|
||||||
logout.title: "Logout"
|
logout.title: "Logout"
|
||||||
menu.currentlyloggedin: "Logged in as: %username%"
|
menu.currentlyloggedin: "%username%"
|
||||||
menu.login: "Login"
|
menu.login: "Login"
|
||||||
menu.logout: "Logout"
|
menu.logout: "Logout"
|
||||||
|
menu.servers.select: "Select a server"
|
||||||
|
menu.servers.deselect: "Deselect server"
|
||||||
mismatch: "There is no validation rule for %field%."
|
mismatch: "There is no validation rule for %field%."
|
||||||
no_entities.message: "Nothing to show."
|
no_entities.message: "Nothing to show."
|
||||||
validate_alpha_dash: "The %field% field may only contain alpha characters and dashes."
|
validate_alpha_dash: "The %field% field may only contain alpha characters and dashes."
|
||||||
|
@ -56,10 +61,21 @@ menu.servers: "Servers"
|
||||||
menu.logs: "Logs"
|
menu.logs: "Logs"
|
||||||
menu.profile: "Profile"
|
menu.profile: "Profile"
|
||||||
|
|
||||||
|
menu.servers.info: "Info"
|
||||||
|
menu.servers.online: "Online"
|
||||||
|
menu.servers.channels: "Channels"
|
||||||
|
menu.servers.clients: "Clients"
|
||||||
|
menu.servers.groups: "Groups"
|
||||||
|
menu.servers.bans: "Bans"
|
||||||
|
menu.servers.complains: "Complains"
|
||||||
|
menu.servers.passwords: "Passwords"
|
||||||
|
menu.servers.tokens: "Tokens"
|
||||||
|
menu.servers.snapshots: "Snapshots"
|
||||||
|
menu.servers.logs: "Log"
|
||||||
|
|
||||||
# titles
|
# titles
|
||||||
instance.title: "Instance"
|
instance.title: "Instance"
|
||||||
servers.title: "Servers"
|
servers.title: "Servers"
|
||||||
logs.title: "Latest 100 Logs"
|
|
||||||
server_info.title: "Server Info"
|
server_info.title: "Server Info"
|
||||||
online.title: "Online Clients"
|
online.title: "Online Clients"
|
||||||
online_info.title: "Online Info"
|
online_info.title: "Online Info"
|
||||||
|
@ -70,8 +86,15 @@ clients.title: "Clients"
|
||||||
bans.title: "Bans"
|
bans.title: "Bans"
|
||||||
complains.title: "Complains"
|
complains.title: "Complains"
|
||||||
groups.title: "Groups"
|
groups.title: "Groups"
|
||||||
group_info.title: "Group Info"
|
servergroup_info.title: "Server Group Info"
|
||||||
|
channelgroup_info.title: "Channelgroup"
|
||||||
profile.title: "Profile"
|
profile.title: "Profile"
|
||||||
|
tokens.title: "Tokens"
|
||||||
|
snapshots.title: "Snapshots"
|
||||||
|
passwords.title: "Passwords"
|
||||||
|
instance_logs.title: "Instance log"
|
||||||
|
server_logs.title: "Server log"
|
||||||
|
app_log.title: "Application log"
|
||||||
|
|
||||||
# dynamic render of key value pairs
|
# dynamic render of key value pairs
|
||||||
key: "Attribute"
|
key: "Attribute"
|
||||||
|
@ -94,11 +117,7 @@ instance_edit.edited.success: "Edited instance."
|
||||||
servers.noneselected: "Cannot find server."
|
servers.noneselected: "Cannot find server."
|
||||||
servers.start: "Start"
|
servers.start: "Start"
|
||||||
servers.stop: "Stop"
|
servers.stop: "Stop"
|
||||||
servers.channels: "Channels"
|
servers.select: "Select"
|
||||||
servers.clients: "Clients"
|
|
||||||
servers.groups: "Groups"
|
|
||||||
servers.bans: "Bans"
|
|
||||||
servers.complains: "Complains"
|
|
||||||
servers.delete: "Delete"
|
servers.delete: "Delete"
|
||||||
servers.started.success: "Started virtual server %sid%."
|
servers.started.success: "Started virtual server %sid%."
|
||||||
servers.stopped.success: "Stopped virtual server %sid%."
|
servers.stopped.success: "Stopped virtual server %sid%."
|
||||||
|
@ -126,36 +145,62 @@ server_info.send.message: "Message"
|
||||||
|
|
||||||
# channels
|
# channels
|
||||||
channels.delete: "Delete"
|
channels.delete: "Delete"
|
||||||
|
channels.h.actions: "Actions"
|
||||||
|
channels.h.details: "Details"
|
||||||
|
channels.create: "Create a channel"
|
||||||
|
channels.create.channel_name: "Name"
|
||||||
|
channels.create.channel_order: "Order"
|
||||||
|
channels.create.semi_permanent: "Semi permanent"
|
||||||
|
channels.create.permanent: "Permanent"
|
||||||
|
channels.create.inherit: "Has a parent?"
|
||||||
|
channels.create.parent: "Parent"
|
||||||
|
|
||||||
# channel info
|
# channel info
|
||||||
channel_info.h.files: "Files"
|
channel_info.h.files: "Files"
|
||||||
channel_info.h.actions: "Actions"
|
channel_info.h.actions: "Actions"
|
||||||
channel_info.h.details: "Details"
|
channel_info.h.details: "Details"
|
||||||
channel_info.h.clients: "Clients"
|
channel_info.h.clients: "Current clients"
|
||||||
channel_info.send: "Send a message"
|
channel_info.send: "Send a message"
|
||||||
channel_info.send.message: "Message"
|
channel_info.send.message: "Message"
|
||||||
|
channel_info.client: "Client"
|
||||||
|
channel_info.files.delete: "Delete"
|
||||||
|
channel_info.files.h.path: "Path"
|
||||||
|
channel_info.files.h.type: "Type"
|
||||||
|
channel_info.files.h.size: "Size"
|
||||||
|
channel_info.files.h.datetime: "Datetime"
|
||||||
|
channel_info.files.h.delete: "Delete"
|
||||||
|
channel_info.files.delete.success: "Deleted %file%."
|
||||||
|
# groups
|
||||||
|
groups.delete: "Delete"
|
||||||
|
groups.h.servergroups: "Server Groups"
|
||||||
|
groups.h.channelgroups: "Channel Groups"
|
||||||
|
groups.servergroup: "Server Group"
|
||||||
|
groups.channelgroup: "Channel Group"
|
||||||
|
|
||||||
|
# groups create/copy
|
||||||
|
groups.create: "Create or copy"
|
||||||
|
groups.create.name: "Name"
|
||||||
|
groups.create.type: "Type"
|
||||||
|
groups.create.copy: "Copy? If checked, select a template."
|
||||||
|
groups.create.template: "Template"
|
||||||
|
|
||||||
# channelgroups
|
# channelgroups
|
||||||
channelgroups.delete: "Delete"
|
channelgroups.delete: "Delete"
|
||||||
|
|
||||||
# channelgroup info
|
# channelgroup info
|
||||||
channelgroup_info.title: "Channelgroup"
|
|
||||||
channelgroup_info.h.clients: "Clients"
|
channelgroup_info.h.clients: "Clients"
|
||||||
channelgroup_info.h.permissions: "Permissions"
|
channelgroup_info.h.permissions: "Permissions"
|
||||||
channelgroup_info.remove: "Remove"
|
channelgroup_info.remove: "Remove"
|
||||||
|
channelgroup_info.client: "Client"
|
||||||
|
channelgroup_info.channel: "Channel"
|
||||||
|
|
||||||
# groups
|
# server group info
|
||||||
groups.delete: "Delete"
|
servergroup_info.h.clients_add: "Add"
|
||||||
groups.h.servergroups: "Server Groups"
|
servergroup_info.h.clients: "Clients"
|
||||||
groups.h.channelgroups: "Channel Groups"
|
servergroup_info.h.permissions: "Permissions"
|
||||||
|
servergroup_info.remove: "Remove"
|
||||||
# group info
|
servergroup_info.add: "Add a client"
|
||||||
group_info.h.clients_add: "Add"
|
servergroup_info.add.cldbid: "Client Database Id"
|
||||||
group_info.h.clients: "Clients"
|
|
||||||
group_info.h.permissions: "Permissions"
|
|
||||||
group_info.remove: "Remove"
|
|
||||||
group_info.add: "Add a client"
|
|
||||||
group_info.add.cldbid: "Client Database Id"
|
|
||||||
|
|
||||||
# clients
|
# clients
|
||||||
clients.delete: "Delete"
|
clients.delete: "Delete"
|
||||||
|
@ -174,6 +219,8 @@ client_info.send: "Send a message"
|
||||||
client_info.send.subject: "Subject"
|
client_info.send.subject: "Subject"
|
||||||
client_info.send.message: "Message"
|
client_info.send.message: "Message"
|
||||||
client_info.sent.success: "Sent message to client %cldbid%."
|
client_info.sent.success: "Sent message to client %cldbid%."
|
||||||
|
client_info.channel: "Channel"
|
||||||
|
client_info.channelgroup: "Channelgroup"
|
||||||
|
|
||||||
# online info
|
# online info
|
||||||
online_info.h.actions: "Actions"
|
online_info.h.actions: "Actions"
|
||||||
|
@ -186,6 +233,10 @@ bans.delete: "Delete"
|
||||||
complains.delete: "Delete"
|
complains.delete: "Delete"
|
||||||
|
|
||||||
# online
|
# online
|
||||||
|
online.move: "Move"
|
||||||
|
online.move.channel: "Channel"
|
||||||
|
online.move.channel_password: "Channel password"
|
||||||
|
online.moved.success: "Moved client %clid%."
|
||||||
online.kick: "Kick"
|
online.kick: "Kick"
|
||||||
online.kick.reason: "Reason"
|
online.kick.reason: "Reason"
|
||||||
online.poke: "Poke"
|
online.poke: "Poke"
|
||||||
|
@ -198,3 +249,39 @@ online.send.message: "Message"
|
||||||
online.poked.success: "Poked client %clid%."
|
online.poked.success: "Poked client %clid%."
|
||||||
online.kicked.success: "Kicked client %clid%."
|
online.kicked.success: "Kicked client %clid%."
|
||||||
online.banned.success: "Banned client %clid%."
|
online.banned.success: "Banned client %clid%."
|
||||||
|
online.client: "Client"
|
||||||
|
online.channel: "Channel"
|
||||||
|
|
||||||
|
# tokens
|
||||||
|
tokens.delete: "Delete"
|
||||||
|
tokens.h.details: "Details"
|
||||||
|
tokens.h.add: "Add"
|
||||||
|
tokens.add: "Add a token"
|
||||||
|
tokens.add.tokentype: "Type"
|
||||||
|
tokens.add.serverGroup: "Servergroup (type SERVER has to be selected)"
|
||||||
|
tokens.add.channelGroup: "Channelgroup (type CHANNEL has to be selected)"
|
||||||
|
tokens.add.channel: "Channel (type CHANNEL has to be selected)"
|
||||||
|
tokens.add.description: "Description"
|
||||||
|
|
||||||
|
# snapshots
|
||||||
|
file.exists: "File already exists"
|
||||||
|
file.notexists: "File does not exist"
|
||||||
|
snapshots.h.actions: "Actions"
|
||||||
|
snapshots.create: "Create a new snapshot"
|
||||||
|
snapshots.h.details: "Details"
|
||||||
|
snapshots.deploy: "Deploy"
|
||||||
|
snapshots.delete: "Delete"
|
||||||
|
snapshots.error.create: "An error occurred when creating a snapshot. Please view the application log."
|
||||||
|
snapshots.error.delete: "An error occurred when deleting a snapshot. Please view the application log."
|
||||||
|
snapshots.error.deploy: "An error occurred when deploying a snapshot. Please view the application log."
|
||||||
|
|
||||||
|
# passwords
|
||||||
|
passwords.h.actions: "Actions"
|
||||||
|
passwords.h.details: "Details"
|
||||||
|
passwords.add: "Add a temporary password"
|
||||||
|
passwords.add.password: "Password"
|
||||||
|
passwords.add.duration: "Duration (in seconds)"
|
||||||
|
passwords.add.description: "Description"
|
||||||
|
passwords.add.channel: "Channel (user joins)"
|
||||||
|
passwords.add.channel_password: "Channelpassword"
|
||||||
|
passwords.channel: "Channel"
|
0
data/snapshots/.gitkeep
Normal file
22
docker/configure.php
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
#!/usr/bin/env php
|
||||||
|
<?php
|
||||||
|
|
||||||
|
echo "Adapting ENV_DIR..." . PHP_EOL;
|
||||||
|
|
||||||
|
$path = '/etc/php7/php-fpm.d/www.conf';
|
||||||
|
$env = "ENV_DIR";
|
||||||
|
|
||||||
|
$fileContent = file_get_contents($path);
|
||||||
|
$fileContent = preg_replace("/%%%" . strtoupper($env) . "%%%/", env($env, "/var/www/html/application/config"), $fileContent);
|
||||||
|
file_put_contents($path, $fileContent);
|
||||||
|
|
||||||
|
function env($name, $default = null)
|
||||||
|
{
|
||||||
|
$v = getenv($name) ?: $default;
|
||||||
|
|
||||||
|
if ($v === null) {
|
||||||
|
return "''";
|
||||||
|
}
|
||||||
|
|
||||||
|
return "'" . $v . "'";
|
||||||
|
}
|
41
docker/nginx.conf
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
daemon off;
|
||||||
|
pid /run/nginx.pid;
|
||||||
|
worker_processes 1;
|
||||||
|
|
||||||
|
events {
|
||||||
|
worker_connections 1024;
|
||||||
|
}
|
||||||
|
|
||||||
|
http {
|
||||||
|
include mime.types;
|
||||||
|
default_type application/octet-stream;
|
||||||
|
|
||||||
|
sendfile on;
|
||||||
|
keepalive_timeout 65;
|
||||||
|
gzip off;
|
||||||
|
client_max_body_size 0;
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
root /var/www/html/application/public;
|
||||||
|
index index.php index.html;
|
||||||
|
|
||||||
|
rewrite_log on;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ @ee;
|
||||||
|
}
|
||||||
|
|
||||||
|
location @ee {
|
||||||
|
rewrite ^(.*) /index.php?$1 last;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ \.php$ {
|
||||||
|
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||||
|
fastcgi_pass 127.0.0.1:9000;
|
||||||
|
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
|
||||||
|
fastcgi_index index.php;
|
||||||
|
include fastcgi_params;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
3
docker/s6/nginx/run
Executable file
|
@ -0,0 +1,3 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
exec /usr/sbin/nginx
|
3
docker/s6/php-fpm/run
Executable file
|
@ -0,0 +1,3 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
exec /usr/sbin/php-fpm7 --nodaemonize
|
BIN
public/images/flags/ad.png
Normal file
After Width: | Height: | Size: 643 B |
BIN
public/images/flags/ae.png
Normal file
After Width: | Height: | Size: 408 B |
BIN
public/images/flags/af.png
Normal file
After Width: | Height: | Size: 604 B |
BIN
public/images/flags/ag.png
Normal file
After Width: | Height: | Size: 591 B |
BIN
public/images/flags/ai.png
Normal file
After Width: | Height: | Size: 643 B |
BIN
public/images/flags/al.png
Normal file
After Width: | Height: | Size: 600 B |
BIN
public/images/flags/am.png
Normal file
After Width: | Height: | Size: 497 B |
BIN
public/images/flags/an.png
Normal file
After Width: | Height: | Size: 488 B |
BIN
public/images/flags/ao.png
Normal file
After Width: | Height: | Size: 428 B |
BIN
public/images/flags/ar.png
Normal file
After Width: | Height: | Size: 506 B |
BIN
public/images/flags/as.png
Normal file
After Width: | Height: | Size: 647 B |
BIN
public/images/flags/at.png
Normal file
After Width: | Height: | Size: 403 B |
BIN
public/images/flags/au.png
Normal file
After Width: | Height: | Size: 673 B |
BIN
public/images/flags/aw.png
Normal file
After Width: | Height: | Size: 524 B |
BIN
public/images/flags/ax.png
Normal file
After Width: | Height: | Size: 663 B |
BIN
public/images/flags/az.png
Normal file
After Width: | Height: | Size: 589 B |
BIN
public/images/flags/ba.png
Normal file
After Width: | Height: | Size: 593 B |
BIN
public/images/flags/bb.png
Normal file
After Width: | Height: | Size: 585 B |
BIN
public/images/flags/bd.png
Normal file
After Width: | Height: | Size: 504 B |
BIN
public/images/flags/be.png
Normal file
After Width: | Height: | Size: 449 B |
BIN
public/images/flags/bf.png
Normal file
After Width: | Height: | Size: 497 B |
BIN
public/images/flags/bg.png
Normal file
After Width: | Height: | Size: 462 B |
BIN
public/images/flags/bh.png
Normal file
After Width: | Height: | Size: 457 B |
BIN
public/images/flags/bi.png
Normal file
After Width: | Height: | Size: 675 B |
BIN
public/images/flags/bj.png
Normal file
After Width: | Height: | Size: 486 B |
BIN
public/images/flags/bl.png
Normal file
After Width: | Height: | Size: 545 B |
BIN
public/images/flags/bm.png
Normal file
After Width: | Height: | Size: 611 B |
BIN
public/images/flags/bn.png
Normal file
After Width: | Height: | Size: 639 B |
BIN
public/images/flags/bo.png
Normal file
After Width: | Height: | Size: 500 B |
BIN
public/images/flags/br.png
Normal file
After Width: | Height: | Size: 593 B |
BIN
public/images/flags/bs.png
Normal file
After Width: | Height: | Size: 526 B |
BIN
public/images/flags/bt.png
Normal file
After Width: | Height: | Size: 631 B |
BIN
public/images/flags/bv.png
Normal file
After Width: | Height: | Size: 512 B |
BIN
public/images/flags/bw.png
Normal file
After Width: | Height: | Size: 443 B |
BIN
public/images/flags/by.png
Normal file
After Width: | Height: | Size: 514 B |
BIN
public/images/flags/bz.png
Normal file
After Width: | Height: | Size: 600 B |
BIN
public/images/flags/ca.png
Normal file
After Width: | Height: | Size: 628 B |
BIN
public/images/flags/cc.png
Normal file
After Width: | Height: | Size: 625 B |
BIN
public/images/flags/cd.png
Normal file
After Width: | Height: | Size: 528 B |
BIN
public/images/flags/cf.png
Normal file
After Width: | Height: | Size: 614 B |
BIN
public/images/flags/cg.png
Normal file
After Width: | Height: | Size: 521 B |
BIN
public/images/flags/ch.png
Normal file
After Width: | Height: | Size: 367 B |
BIN
public/images/flags/ci.png
Normal file
After Width: | Height: | Size: 453 B |
BIN
public/images/flags/ck.png
Normal file
After Width: | Height: | Size: 586 B |
BIN
public/images/flags/cl.png
Normal file
After Width: | Height: | Size: 450 B |
BIN
public/images/flags/cm.png
Normal file
After Width: | Height: | Size: 525 B |
BIN
public/images/flags/cn.png
Normal file
After Width: | Height: | Size: 472 B |
BIN
public/images/flags/co.png
Normal file
After Width: | Height: | Size: 483 B |
BIN
public/images/flags/cr.png
Normal file
After Width: | Height: | Size: 477 B |
BIN
public/images/flags/cs.png
Normal file
After Width: | Height: | Size: 439 B |
BIN
public/images/flags/cu.png
Normal file
After Width: | Height: | Size: 563 B |
BIN
public/images/flags/cv.png
Normal file
After Width: | Height: | Size: 529 B |
BIN
public/images/flags/cx.png
Normal file
After Width: | Height: | Size: 608 B |
BIN
public/images/flags/cy.png
Normal file
After Width: | Height: | Size: 428 B |
BIN
public/images/flags/cz.png
Normal file
After Width: | Height: | Size: 476 B |
BIN
public/images/flags/de.png
Normal file
After Width: | Height: | Size: 545 B |
BIN
public/images/flags/dj.png
Normal file
After Width: | Height: | Size: 572 B |
BIN
public/images/flags/dk.png
Normal file
After Width: | Height: | Size: 495 B |
BIN
public/images/flags/dm.png
Normal file
After Width: | Height: | Size: 620 B |
BIN
public/images/flags/do.png
Normal file
After Width: | Height: | Size: 508 B |
BIN
public/images/flags/dz.png
Normal file
After Width: | Height: | Size: 582 B |
BIN
public/images/flags/ec.png
Normal file
After Width: | Height: | Size: 500 B |
BIN
public/images/flags/ee.png
Normal file
After Width: | Height: | Size: 429 B |
BIN
public/images/flags/eg.png
Normal file
After Width: | Height: | Size: 465 B |
BIN
public/images/flags/eh.png
Normal file
After Width: | Height: | Size: 508 B |
BIN
public/images/flags/er.png
Normal file
After Width: | Height: | Size: 653 B |
BIN
public/images/flags/es.png
Normal file
After Width: | Height: | Size: 469 B |
BIN
public/images/flags/et.png
Normal file
After Width: | Height: | Size: 592 B |
BIN
public/images/flags/fi.png
Normal file
After Width: | Height: | Size: 489 B |
BIN
public/images/flags/fj.png
Normal file
After Width: | Height: | Size: 610 B |
BIN
public/images/flags/fk.png
Normal file
After Width: | Height: | Size: 648 B |
BIN
public/images/flags/fm.png
Normal file
After Width: | Height: | Size: 552 B |
BIN
public/images/flags/fo.png
Normal file
After Width: | Height: | Size: 474 B |
BIN
public/images/flags/fr.png
Normal file
After Width: | Height: | Size: 545 B |
BIN
public/images/flags/ga.png
Normal file
After Width: | Height: | Size: 489 B |
BIN
public/images/flags/gb.png
Normal file
After Width: | Height: | Size: 599 B |
BIN
public/images/flags/gd.png
Normal file
After Width: | Height: | Size: 637 B |
BIN
public/images/flags/ge.png
Normal file
After Width: | Height: | Size: 594 B |
BIN
public/images/flags/gf.png
Normal file
After Width: | Height: | Size: 545 B |
BIN
public/images/flags/gg.png
Normal file
After Width: | Height: | Size: 362 B |