diff --git a/.dockerignore b/.dockerignore index 7987a48..88eede7 100644 --- a/.dockerignore +++ b/.dockerignore @@ -2,6 +2,7 @@ * # Allow specific files -!/apache.conf +!/apache/* !/php.ini !/koel-entrypoint +!/koel-init \ No newline at end of file diff --git a/.gitignore b/.gitignore index 93e066f..b39e90d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,4 @@ -# Contains DB passwords -.env.dev -# Contains Koel APP_KEY -.env.koel +.env* # Cache for direnv .direnv/ .envrc diff --git a/Dockerfile b/Dockerfile index feee968..9904ffe 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,15 +1,66 @@ # The runtime image. -FROM php:8.4.8-apache-bookworm - +FROM alpine:3.22.1 # The koel version to download ARG KOEL_VERSION_REF=v7.12.0 -# Install vim for easier editing/debugging -RUN apt-get update && apt-get install -y vim +RUN apk add --no-cache --no-interactive \ +curl \ +apache2 \ +apache2-proxy \ + # php-fpm because it's so much faster and efficient in handling web requests, php for cli commands. need to find a way to maybe not have both bloating the image + php \ + php-fpm \ + libzip-dev \ + zip \ + ffmpeg \ + libpng-dev \ + libjpeg-turbo-dev \ + libpq-dev \ + libwebp-dev \ + libavif-dev \ + # https://laravel.com/docs/8.x/deployment#server-requirements + php83-ctype \ + php83-fileinfo \ + php83-json \ + php83-mbstring \ + php83-openssl \ + php83-tokenizer \ + php83-xml \ + php83-dom \ + php83-bcmath \ + php83-exif \ + php83-gd \ + php83-pdo \ + php83-pdo_mysql \ + php83-pdo_pgsql \ + php83-pgsql \ + php83-zip \ + php83-session \ + busybox-suid \ + musl-locales \ + musl-locales-lang \ + tzdata \ + # as well as nano for easier debugging and updating configs + nano \ + ncdu \ + # Set locale to prevent removal of non-ASCII path characters when transcoding with ffmpeg. do this first so all the php configurations make use of this as well +# See https://github.com/koel/docker/pull/91 & https://krython.com/post/resolving-alpine-linux-locale-issues/ + && echo "en_US.UTF-8 UTF-8" > /etc/locale.gen \ + && export LANG=en_US.UTF-8 \ + && export LC_ALL=en_US.UTF-8 \ + && echo 'export LANG=en_US.UTF-8' >> /etc/profile \ + && echo 'export LC_ALL=en_US.UTF-8' >> /etc/profile + -# Download the koel release matching the version and remove anything not necessary for production + +RUN adduser -S www-data -G www-data -h /var/www/ -H +RUN mkdir -p /var/www/html && chown www-data:www-data /var/www/html +USER www-data + +# Download koel and put the files in the right places RUN curl -L https://github.com/koel/koel/releases/download/${KOEL_VERSION_REF}/koel-${KOEL_VERSION_REF}.tar.gz | tar -xz -C /tmp \ && cd /tmp/koel/ \ + # Cleanup the junk from the tar, probably should rework the build at some point to not exclude things not useful outside of dev at that layer already && rm -rf .editorconfig \ .eslintignore \ .eslintrc \ @@ -31,86 +82,108 @@ RUN curl -L https://github.com/koel/koel/releases/download/${KOEL_VERSION_REF}/k ruleset.xml \ scripts/ \ tag.sh \ - vite.config.js - -# Install koel runtime dependencies. -RUN apt-get update \ - && apt-get install --yes --no-install-recommends \ - cron \ - libapache2-mod-xsendfile \ - libzip-dev \ - zip \ - ffmpeg \ - locales \ - libpng-dev \ - libjpeg62-turbo-dev \ - libpq-dev \ - libwebp-dev \ - libavif-dev \ - && docker-php-ext-configure gd --with-jpeg --with-webp --with-avif \ - # https://laravel.com/docs/8.x/deployment#server-requirements - # ctype, fileinfo, json, mbstring, openssl, tokenizer and xml are already activated in the base image - && docker-php-ext-install \ - bcmath \ - exif \ - gd \ - pdo \ - pdo_mysql \ - pdo_pgsql \ - pgsql \ - zip \ - && apt-get clean \ - # Create the music volume so it has the correct permissions - && mkdir /music \ - && chown www-data:www-data /music \ + vite.config.js \ + tests/songs \ + pnpm-lock.yaml \ + .husky \ + README.md \ + CODE_OF_CONDUCT.md \ + .vscode \ + tailwind.config.js \ + eslint.config.js \ + postcss.config.cjs \ + commitling.config.js \ + .htaccess.example \ + && cp -R /tmp/koel/. /var/www/html \ + # we use php-pfm because it's plain better, but that means htaccess php directives can't be parsed here + && sed -e '/^php*/ s/^#*/#/' -i /var/www/html/public/.htaccess \ # Create the search-indexes volume so it has the correct permissions && mkdir -p /var/www/html/storage/search-indexes \ - && chown www-data:www-data /var/www/html/storage/search-indexes \ - # Set locale to prevent removal of non-ASCII path characters when transcoding with ffmpeg - # See https://github.com/koel/docker/pull/91 - && echo "en_US.UTF-8 UTF-8" > /etc/locale.gen \ - && /usr/sbin/locale-gen - -# Copy Apache configuration -COPY ./apache.conf /etc/apache2/sites-available/000-default.conf + && [ ! -f /var/www/html/public/manifest.json ] && cp /var/www/html/public/manifest.json.example /var/www/html/public/manifest.json || true \ + && chown -R www-data:www-data /var/www/html \ + # Cleanup the temp download + && rm -rf /tmp/* -# Copy php.ini -COPY ./php.ini "$PHP_INI_DIR/php.ini" -# /usr/local/etc/php/php.ini -# Deploy Apache configuration -RUN a2enmod rewrite +# Install x-sendfile for apache2, fix home folder +USER root +RUN apk add --no-cache apache2-dev gcc musl-dev \ + && curl -o mod_xsendfile.c https://tn123.org/mod_xsendfile/mod_xsendfile.c \ + && apxs -cia mod_xsendfile.c \ + && rm mod_xsendfile.* \ + && apk del --no-cache apache2-dev gcc musl-dev \ + && mkdir /var/www/lib \ + && ln -s /usr/lib/apache2 /var/www/lib/apache2 -# Copy the downloaded release -RUN cp -R /tmp/koel/. /var/www/html -RUN [ ! -f /var/www/html/public/manifest.json ] && cp /var/www/html/public/manifest.json.example /var/www/html/public/manifest.json || true -RUN chown -R www-data:www-data /var/www/html -# Create /tmp/koel if it doesn't exist, and set ownership to www-data +# Create /tmp/koel RUN mkdir -p /tmp/koel \ - && chown www-data:www-data /tmp/koel \ - && chmod 755 /tmp/koel + && chown www-data:www-data /tmp/koel \ + && chmod 755 /tmp/koel\ + # Create the music volume so + && mkdir /music \ + && chown www-data:www-data /music \ + && mkdir -p /cache/img/artists \ + && mkdir -p /cache/img/avatars \ + && mkdir -p /cache/img/covers \ + && mkdir -p /cache/img/playlists \ + && mkdir -p /cache/img/radio-stations \ + && chown -R www-data:www-data /cache \ + && chmod -R 755 /cache \ + # redirect public img storage into the cache, putting this here and not with the other koel file setups because it makes more sense here, and they are empty folder so don't have a significant impact on file size + && rm -r /var/www/html/public/img/artists \ + && rm -r /var/www/html/public/img/avatars \ + && rm -r /var/www/html/public/img/covers \ + && rm -r /var/www/html/public/img/playlists \ + && ln -s /cache/img/artists /var/www/html/public/img/artists \ + && ln -s /cache/img/avatars /var/www/html/public/img/avatars \ + && ln -s /cache/img/covers /var/www/html/public/img/covers \ + && ln -s /cache/img/playlists /var/www/html/public/img/playlists \ + && ln -s /cache/img/radio-stations /var/www/html/public/img/radio-stations -# Volumes for the music files and search index +# Volumes for the music files, search index and image cache # This declaration must be AFTER creating the folders and setting their permissions # and AFTER changing to non-root user. # Otherwise, they are owned by root and the user cannot write to them. -VOLUME ["/music", "/var/www/html/storage/search-indexes"] +VOLUME ["/music", "/var/www/html/storage/search-indexes", "/cache"] + + +# Copy Apache configuration +COPY apache/site.conf /etc/apache2/conf.d/ +COPY apache/httpd.conf /etc/apache2/ +COPY apache/www.conf /etc/php83/php-fpm.d/ + +# Copy php.ini +COPY ./php.ini "$PHP_INI_DIR/php.ini" + +# make crontab file +RUN touch /etc/crontabs/www-data + +# Apply lalvel optimalizations +RUN cd /var/www/html \ + && php artisan route:cache \ + && php artisan event:cache \ + && php artisan view:cache + ENV FFMPEG_PATH=/usr/bin/ffmpeg \ MEDIA_PATH=/music \ STREAMING_METHOD=x-sendfile \ LANG=en_US.UTF-8 \ LANGUAGE=en_US:en \ - LC_ALL=en_US.UTF-8 + LC_ALL=en_US.UTF-8 \ + APACHE_LOG_DIR=/var/log/apache2 # Setup bootstrap script. COPY koel-entrypoint /usr/local/bin/ +COPY koel-init /usr/local/bin/ ENTRYPOINT ["koel-entrypoint"] -CMD ["apache2-foreground"] +CMD [""] EXPOSE 80 # Check that the homepage is displayed HEALTHCHECK --start-period=30s --interval=5m --timeout=5s \ CMD curl -f http://localhost/sw.js || exit 1 + + \ No newline at end of file diff --git a/README.md b/README.md index 8c5a5a0..df1b1f5 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,15 @@ docker-compose -f ./docker-compose.postgres.yml up -d ## The `koel:init` command +This command is automatically ran when the container starts, but can be disabled if you want to do some manual adjustments first. As such it is often sufficient to provide the needed env variables to the container to setup koel. + For the first installation and every subsequent upgrade, you will need to run the `koel:init` command, which handles migrations and other setup tasks. For instance, during the first run, this command will generate the `APP_KEY`, create the default admin user, and initialize the database. For subsequent runs, it will apply any new migrations and update the database schema as needed. In order to run this command, you first need to `exec` into the container (replace `` with the name of your running Koel container): ```bash -docker exec --user www-data -it bash +docker exec --user www-data -it sh ``` Once inside the container, run the `koel:init` command: @@ -142,7 +144,7 @@ Once you have generated an `APP_KEY` you can provide it as environment variables ```bash # Run a container just to generate the key -docker run -it --rm phanan/koel bash +docker run -it --rm phanan/koel sh # In the container, generate APP_KEY $ php artisan key:generate --force # Show the modified .env file @@ -188,7 +190,7 @@ For all new songs, the search index will be automatically populated by `php arti > [!IMPORTANT] > This list is not exhaustive and may not be up-to-date. See [`.env.example`][koel-env-example] for a complete reference. - +- `SKIP_INIT` : set a value to prevent the container from automatically running the init script on startup - `DB_CONNECTION`: `mysql` OR `pgsql` OR `sqlsrv` OR `sqlite-persistent`. Corresponds to the type of database being used with Koel. - `DB_HOST`: `database`. The name of the Docker container hosting the database. Koel needs to be on the same Docker network to find the database by its name. - `DB_USERNAME`: `koel`. If you change it, also change it in the database container. @@ -199,6 +201,7 @@ For all new songs, the search index will be automatically populated by `php arti - `MEMORY_LIMIT`: The amount of memory in MB for the scanning process. Increase this value if `php artisan koel:scan` runs out of memory. - `LASTFM_API_KEY` and `LASTFM_API_SECRET`: Enables Last.fm integration. See https://docs.koel.dev/3rd-party.html#last-fm - `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`: Enables Spotify integration. See https://docs.koel.dev/3rd-party.html#spotify +- `OPTIMIZE_CONFIG` Preload and optimize the config. This disables your ability to do config edits while the container is running. If you enable this every config change will require a container restart to apply. ## Volumes diff --git a/apache/httpd.conf b/apache/httpd.conf new file mode 100644 index 0000000..d4167a0 --- /dev/null +++ b/apache/httpd.conf @@ -0,0 +1,488 @@ +# +# This is the main Apache HTTP server configuration file. It contains the +# configuration directives that give the server its instructions. +# See for detailed information. +# In particular, see +# +# for a discussion of each configuration directive. +# +# Do NOT simply read the instructions in here without understanding +# what they do. They're here only as hints or reminders. If you are unsure +# consult the online docs. You have been warned. +# +# Configuration and logfile names: If the filenames you specify for many +# of the server's control files begin with "/" (or "drive:/" for Win32), the +# server will use that explicit path. If the filenames do *not* begin +# with "/", the value of ServerRoot is prepended -- so "logs/access_log" +# with ServerRoot set to "/usr/local/apache2" will be interpreted by the +# server as "/usr/local/apache2/logs/access_log", whereas "/logs/access_log" +# will be interpreted as '/logs/access_log'. + +# +# ServerTokens +# This directive configures what you return as the Server HTTP response +# Header. The default is 'Full' which sends information about the OS-Type +# and compiled in modules. +# Set to one of: Full | OS | Minor | Minimal | Major | Prod +# where Full conveys the most information, and Prod the least. +# +ServerTokens OS + +# +# ServerRoot: The top of the directory tree under which the server's +# configuration, error, and log files are kept. +# +# Do not add a slash at the end of the directory path. If you point +# ServerRoot at a non-local disk, be sure to specify a local disk on the +# Mutex directive, if file-based mutexes are used. If you wish to share the +# same ServerRoot for multiple httpd daemons, you will need to change at +# least PidFile. +# +ServerRoot /var/www + +# +# Mutex: Allows you to set the mutex mechanism and mutex file directory +# for individual mutexes, or change the global defaults +# +# Uncomment and change the directory if mutexes are file-based and the default +# mutex file directory is not on a local disk or is not appropriate for some +# other reason. +# +# Mutex default:/run/apache2 + +# +# Listen: Allows you to bind Apache to specific IP addresses and/or +# ports, instead of the default. See also the +# directive. +# +# Change this to Listen on specific IP addresses as shown below to +# prevent Apache from glomming onto all bound IP addresses. +# +#Listen 12.34.56.78:80 +Listen 80 + +# +# Dynamic Shared Object (DSO) Support +# +# To be able to use the functionality of a module which was built as a DSO you +# have to place corresponding `LoadModule' lines at this location so the +# directives contained in it are actually available _before_ they are used. +# Statically compiled modules (those listed by `httpd -l') do not need +# to be loaded here. +# +# Example: +# LoadModule foo_module modules/mod_foo.so +# +LoadModule mpm_event_module modules/mod_mpm_event.so +#LoadModule mpm_prefork_module modules/mod_mpm_prefork.so +#LoadModule mpm_worker_module modules/mod_mpm_worker.so +LoadModule authn_file_module modules/mod_authn_file.so +#LoadModule authn_dbm_module modules/mod_authn_dbm.so +#LoadModule authn_anon_module modules/mod_authn_anon.so +#LoadModule authn_dbd_module modules/mod_authn_dbd.so +#LoadModule authn_socache_module modules/mod_authn_socache.so +LoadModule authn_core_module modules/mod_authn_core.so +LoadModule authz_host_module modules/mod_authz_host.so +LoadModule authz_groupfile_module modules/mod_authz_groupfile.so +LoadModule authz_user_module modules/mod_authz_user.so +#LoadModule authz_dbm_module modules/mod_authz_dbm.so +#LoadModule authz_owner_module modules/mod_authz_owner.so +#LoadModule authz_dbd_module modules/mod_authz_dbd.so +LoadModule authz_core_module modules/mod_authz_core.so +LoadModule access_compat_module modules/mod_access_compat.so +LoadModule auth_basic_module modules/mod_auth_basic.so +#LoadModule auth_form_module modules/mod_auth_form.so +#LoadModule auth_digest_module modules/mod_auth_digest.so +#LoadModule allowmethods_module modules/mod_allowmethods.so +#LoadModule file_cache_module modules/mod_file_cache.so +#LoadModule cache_module modules/mod_cache.so +#LoadModule cache_disk_module modules/mod_cache_disk.so +#LoadModule cache_socache_module modules/mod_cache_socache.so +#LoadModule socache_shmcb_module modules/mod_socache_shmcb.so +#LoadModule socache_dbm_module modules/mod_socache_dbm.so +#LoadModule socache_memcache_module modules/mod_socache_memcache.so +#LoadModule socache_redis_module modules/mod_socache_redis.so +#LoadModule watchdog_module modules/mod_watchdog.so +#LoadModule macro_module modules/mod_macro.so +#LoadModule dbd_module modules/mod_dbd.so +#LoadModule dumpio_module modules/mod_dumpio.so +#LoadModule echo_module modules/mod_echo.so +#LoadModule buffer_module modules/mod_buffer.so +#LoadModule data_module modules/mod_data.so +#LoadModule ratelimit_module modules/mod_ratelimit.so +LoadModule reqtimeout_module modules/mod_reqtimeout.so +#LoadModule ext_filter_module modules/mod_ext_filter.so +#LoadModule request_module modules/mod_request.so +#LoadModule include_module modules/mod_include.so +LoadModule filter_module modules/mod_filter.so +#LoadModule reflector_module modules/mod_reflector.so +#LoadModule substitute_module modules/mod_substitute.so +#LoadModule sed_module modules/mod_sed.so +#LoadModule charset_lite_module modules/mod_charset_lite.so +#LoadModule deflate_module modules/mod_deflate.so +#LoadModule brotli_module modules/mod_brotli.so +LoadModule mime_module modules/mod_mime.so +LoadModule log_config_module modules/mod_log_config.so +#LoadModule log_debug_module modules/mod_log_debug.so +#LoadModule log_forensic_module modules/mod_log_forensic.so +#LoadModule logio_module modules/mod_logio.so +LoadModule env_module modules/mod_env.so +#LoadModule mime_magic_module modules/mod_mime_magic.so +#LoadModule expires_module modules/mod_expires.so +LoadModule headers_module modules/mod_headers.so +#LoadModule usertrack_module modules/mod_usertrack.so +#LoadModule unique_id_module modules/mod_unique_id.so +LoadModule setenvif_module modules/mod_setenvif.so +LoadModule version_module modules/mod_version.so +#LoadModule remoteip_module modules/mod_remoteip.so +#LoadModule session_module modules/mod_session.so +#LoadModule session_cookie_module modules/mod_session_cookie.so +#LoadModule session_crypto_module modules/mod_session_crypto.so +#LoadModule session_dbd_module modules/mod_session_dbd.so +#LoadModule slotmem_shm_module modules/mod_slotmem_shm.so +#LoadModule slotmem_plain_module modules/mod_slotmem_plain.so +#LoadModule dialup_module modules/mod_dialup.so +#LoadModule http2_module modules/mod_http2.so +LoadModule unixd_module modules/mod_unixd.so +#LoadModule heartbeat_module modules/mod_heartbeat.so +#LoadModule heartmonitor_module modules/mod_heartmonitor.so +LoadModule status_module modules/mod_status.so +LoadModule autoindex_module modules/mod_autoindex.so +#LoadModule asis_module modules/mod_asis.so +#LoadModule info_module modules/mod_info.so +#LoadModule suexec_module modules/mod_suexec.so + + #LoadModule cgid_module modules/mod_cgid.so + + + #LoadModule cgi_module modules/mod_cgi.so + +#LoadModule vhost_alias_module modules/mod_vhost_alias.so +#LoadModule negotiation_module modules/mod_negotiation.so +LoadModule dir_module modules/mod_dir.so +#LoadModule actions_module modules/mod_actions.so +#LoadModule speling_module modules/mod_speling.so +#LoadModule userdir_module modules/mod_userdir.so +LoadModule alias_module modules/mod_alias.so +LoadModule rewrite_module modules/mod_rewrite.so + +LoadModule negotiation_module modules/mod_negotiation.so +LoadModule xsendfile_module /usr/lib/apache2/mod_xsendfile.so + + +# +# If you wish httpd to run as a different user or group, you must run +# httpd as root initially and it will switch. +# +# User/Group: The name (or #number) of the user/group to run httpd as. +# It is usually good practice to create a dedicated user and group for +# running httpd, as with most system services. +# +User www-data +Group www-data + + + +# 'Main' server configuration +# +# The directives in this section set up the values used by the 'main' +# server, which responds to any requests that aren't handled by a +# definition. These values also provide defaults for +# any containers you may define later in the file. +# +# All of these directives may appear inside containers, +# in which case these default settings will be overridden for the +# virtual host being defined. +# + +# +# ServerAdmin: Your address, where problems with the server should be +# e-mailed. This address appears on some server-generated pages, such +# as error documents. e.g. admin@your-domain.com +# +ServerAdmin you@example.com + +# +# Optionally add a line containing the server version and virtual host +# name to server-generated pages (internal error documents, FTP directory +# listings, mod_status and mod_info output etc., but not CGI generated +# documents or custom error documents). +# Set to "EMail" to also include a mailto: link to the ServerAdmin. +# Set to one of: On | Off | EMail +# +ServerSignature On + +# +# ServerName gives the name and port that the server uses to identify itself. +# This can often be determined automatically, but we recommend you specify +# it explicitly to prevent problems during startup. +# +# If your host doesn't have a registered DNS name, enter its IP address here. +# +#ServerName www.example.com:80 + +# +# Deny access to the entirety of your server's filesystem. You must +# explicitly permit access to web content directories in other +# blocks below. +# + + AllowOverride none + Require all denied + + +# +# Note that from this point forward you must specifically allow +# particular features to be enabled - so if something's not working as +# you might expect, make sure that you have specifically enabled it +# below. +# + +# +# DocumentRoot: The directory out of which you will serve your +# documents. By default, all requests are taken from this directory, but +# symbolic links and aliases may be used to point to other locations. +# +DocumentRoot "/var/www/html/public" + + # + # Possible values for the Options directive are "None", "All", + # or any combination of: + # Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews + # + # Note that "MultiViews" must be named *explicitly* --- "Options All" + # doesn't give it to you. + # + # The Options directive is both complicated and important. Please see + # http://httpd.apache.org/docs/2.4/mod/core.html#options + # for more information. + # + Options All + allow from all + + # + # AllowOverride controls what directives may be placed in .htaccess files. + # It can be "All", "None", or any combination of the keywords: + # AllowOverride FileInfo AuthConfig Limit + # + AllowOverride All + + # + # Controls who can get stuff from this server. + # + Require all granted + + +# +# DirectoryIndex: sets the file that Apache will serve if a directory +# is requested. +# + + DirectoryIndex index.html + + +# +# The following lines prevent .htaccess and .htpasswd files from being +# viewed by Web clients. +# + + Require all denied + + +# +# ErrorLog: The location of the error log file. +# If you do not specify an ErrorLog directive within a +# container, error messages relating to that virtual host will be +# logged here. If you *do* define an error logfile for a +# container, that host's errors will be logged there and not here. +# +ErrorLog logs/error.log + +# +# LogLevel: Control the number of messages logged to the error_log. +# Possible values include: debug, info, notice, warn, error, crit, +# alert, emerg. +# +LogLevel warn + + + # + # The following directives define some format nicknames for use with + # a CustomLog directive (see below). + # + LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined + LogFormat "%h %l %u %t \"%r\" %>s %b" common + + + # You need to enable mod_logio.c to use %I and %O + LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %I %O" combinedio + + + # + # The location and format of the access logfile (Common Logfile Format). + # If you do not define any access logfiles within a + # container, they will be logged here. Contrariwise, if you *do* + # define per- access logfiles, transactions will be + # logged therein and *not* in this file. + # + #CustomLog logs/access.log common + + # + # If you prefer a logfile with access, agent, and referer information + # (Combined Logfile Format) you can use the following directive. + # + CustomLog logs/access.log combined + + + + # + # Redirect: Allows you to tell clients about documents that used to + # exist in your server's namespace, but do not anymore. The client + # will make a new request for the document at its new location. + # Example: + # Redirect permanent /foo http://www.example.com/bar + + # + # Alias: Maps web paths into filesystem paths and is used to + # access content that does not live under the DocumentRoot. + # Example: + # Alias /webpath /full/filesystem/path + # + # If you include a trailing / on /webpath then the server will + # require it to be present in the URL. You will also likely + # need to provide a section to allow access to + # the filesystem path. + + # + # ScriptAlias: This controls which directories contain server scripts. + # ScriptAliases are essentially the same as Aliases, except that + # documents in the target directory are treated as applications and + # run by the server when requested rather than as documents sent to the + # client. The same rules about trailing "/" apply to ScriptAlias + # directives as to Alias. + # + ScriptAlias /cgi-bin/ "/var/www/localhost/cgi-bin/" + + + + + # + # ScriptSock: On threaded servers, designate the path to the UNIX + # socket used to communicate with the CGI daemon of mod_cgid. + # + #Scriptsock cgisock + + +# +# "/var/www/localhost/cgi-bin" should be changed to whatever your ScriptAliased +# CGI directory exists, if you have that configured. +# + + AllowOverride None + Options None + Require all granted + + + + # + # Avoid passing HTTP_PROXY environment to CGI's on this or any proxied + # backend servers which have lingering "httpoxy" defects. + # 'Proxy' request header is undefined by the IETF, not listed by IANA + # + RequestHeader unset Proxy early + + + + # + # TypesConfig points to the file containing the list of mappings from + # filename extension to MIME-type. + # + TypesConfig /etc/apache2/mime.types + + # + # AddType allows you to add to or override the MIME configuration + # file specified in TypesConfig for specific file types. + # + #AddType application/x-gzip .tgz + # + # AddEncoding allows you to have certain browsers uncompress + # information on the fly. Note: Not all browsers support this. + # + #AddEncoding x-compress .Z + #AddEncoding x-gzip .gz .tgz + # + # If the AddEncoding directives above are commented-out, then you + # probably should define those extensions to indicate media types: + # + AddType application/x-compress .Z + AddType application/x-gzip .gz .tgz + + # + # AddHandler allows you to map certain file extensions to "handlers": + # actions unrelated to filetype. These can be either built into the server + # or added with the Action directive (see below) + # + # To use CGI scripts outside of ScriptAliased directories: + # (You will also need to add "ExecCGI" to the "Options" directive.) + # + #AddHandler cgi-script .cgi + + # For type maps (negotiated resources): + #AddHandler type-map var + + # + # Filters allow you to process content before it is sent to the client. + # + # To parse .shtml files for server-side includes (SSI): + # (You will also need to add "Includes" to the "Options" directive.) + # + #AddType text/html .shtml + #AddOutputFilter INCLUDES .shtml + + +# +# The mod_mime_magic module allows the server to use various hints from the +# contents of the file itself to determine its type. The MIMEMagicFile +# directive tells the module where the hint definitions are located. +# + + MIMEMagicFile /etc/apache2/magic + + +# +# Customizable error responses come in three flavors: +# 1) plain text 2) local redirects 3) external redirects +# +# Some examples: +#ErrorDocument 500 "The server made a boo boo." +#ErrorDocument 404 /missing.html +#ErrorDocument 404 "/cgi-bin/missing_handler.pl" +#ErrorDocument 402 http://www.example.com/subscription_info.html +# + +# +# MaxRanges: Maximum number of Ranges in a request before +# returning the entire resource, or one of the special +# values 'default', 'none' or 'unlimited'. +# Default setting is to accept 200 Ranges. +#MaxRanges unlimited + +# +# EnableMMAP and EnableSendfile: On systems that support it, +# memory-mapping or the sendfile syscall may be used to deliver +# files. This usually improves server performance, but must +# be turned off when serving from networked-mounted +# filesystems or if support for these functions is otherwise +# broken on your system. +# Defaults: EnableMMAP On, EnableSendfile Off +# +#EnableMMAP off +#EnableSendfile on + + + SetHandler "proxy:fcgi://127.0.0.1:9000" + + +# Load config files from the config directory "/etc/apache2/conf.d". +# +IncludeOptional /etc/apache2/conf.d/*.conf diff --git a/apache.conf b/apache/site.conf similarity index 60% rename from apache.conf rename to apache/site.conf index f46933e..4796d6b 100644 --- a/apache.conf +++ b/apache/site.conf @@ -20,18 +20,6 @@ ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined - # For most configuration files from conf-available/, which are - # enabled or disabled at a global level, it is possible to - # include a line for only one particular virtual host. For example the - # following line enables the CGI configuration for this host only - # after it has been globally disabled with "a2disconf". - #Include conf-available/serve-cgi-bin.conf - - LoadModule xsendfile_module libexec/apache2/mod_xsendfile.so - - # These configuration can be put in the VirtualHost directive as well - - XSendFile on - XSendFilePath /music - - + # Enable php handling + DirectoryIndex index.php index.html + \ No newline at end of file diff --git a/apache/www.conf b/apache/www.conf new file mode 100644 index 0000000..ff0ded9 --- /dev/null +++ b/apache/www.conf @@ -0,0 +1,76 @@ +; Start a new pool named 'www'. +; the variable $pool can be used in any directive and will be replaced by the +; pool name ('www' here) +[www] +; Unix user/group of the child processes. This can be used only if the master +; process running user is root. It is set after the child process is created. +; The user and group can be specified either by their name or by their numeric +; IDs. +; Note: If the user is root, the executable needs to be started with +; --allow-to-run-as-root option to work. +; Default Values: The user is set to master process running user by default. +; If the group is not set, the user's group is used. +user = www-data +group = www-data + +; The address on which to accept FastCGI requests. +; Valid syntaxes are: +; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on +; a specific port; +; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on +; a specific port; +; 'port' - to listen on a TCP socket to all addresses +; (IPv6 and IPv4-mapped) on a specific port; +; '/path/to/unix/socket' - to listen on a unix socket. +; Note: This value is mandatory. +listen = 127.0.0.1:9000 + +; Choose how the process manager will control the number of child processes. +; Possible Values: +; static - a fixed number (pm.max_children) of child processes; +; dynamic - the number of child processes are set dynamically based on the +; following directives. With this process management, there will be +; always at least 1 children. +; pm.max_children - the maximum number of children that can +; be alive at the same time. +; pm.start_servers - the number of children created on startup. +; pm.min_spare_servers - the minimum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is less than this +; number then some children will be created. +; pm.max_spare_servers - the maximum number of children in 'idle' +; state (waiting to process). If the number +; of 'idle' processes is greater than this +; number then some children will be killed. +; pm.max_spawn_rate - the maximum number of rate to spawn child +; processes at once. +; ondemand - no children are created at startup. Children will be forked when +; new requests will connect. The following parameter are used: +; pm.max_children - the maximum number of children that +; can be alive at the same time. +; pm.process_idle_timeout - The number of seconds after which +; an idle process will be killed. +; Note: This value is mandatory. +pm = dynamic + +; The number of child processes to be created when pm is set to 'static' and the +; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. +; This value sets the limit on the number of simultaneous requests that will be +; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. +; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP +; CGI. The below defaults are based on a server without much resources. Don't +; forget to tweak pm.* to fit your needs. +; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' +; Note: This value is mandatory. +pm.max_children = 5 + +; The desired minimum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +pm.min_spare_servers = 1 + +; The desired maximum number of idle server processes. +; Note: Used only when pm is set to 'dynamic' +; Note: Mandatory when pm is set to 'dynamic' +pm.max_spare_servers = 3 + diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml index 48c0eb8..48ac4ff 100644 --- a/docker-compose.dev.yml +++ b/docker-compose.dev.yml @@ -19,7 +19,7 @@ services: - DB_PASSWORD=password volumes: - music:/music - - covers:/var/www/html/public/img/covers + - cache:/cache - search_index:/var/www/html/storage/search-indexes - ./.env.koel:/var/www/html/.env - ./sql:/docker-entrypoint-initdb.d diff --git a/docker-compose.mysql.yml b/docker-compose.mysql.yml index 0b52d5e..0a3a7be 100644 --- a/docker-compose.mysql.yml +++ b/docker-compose.mysql.yml @@ -15,7 +15,7 @@ services: - DB_DATABASE=koel volumes: - music:/music - - covers:/var/www/html/public/img/covers + - cache:/cache - search_index:/var/www/html/storage/search-indexes - ./sql:/docker-entrypoint-initdb.d diff --git a/docker-compose.postgres.yml b/docker-compose.postgres.yml index bbfabe8..374ba74 100644 --- a/docker-compose.postgres.yml +++ b/docker-compose.postgres.yml @@ -16,7 +16,7 @@ services: - DB_DATABASE=koel volumes: - music:/music - - covers:/var/www/html/public/img/covers + - cache:/cache - search_index:/var/www/html/storage/search-indexes database: diff --git a/goss.yaml b/goss.yaml index f1225ec..f8246b0 100644 --- a/goss.yaml +++ b/goss.yaml @@ -87,41 +87,35 @@ file: package: ffmpeg: installed: true - libapache2-mod-xsendfile: - installed: true port: tcp:80: listening: true ip: - - 0.0.0.0 -service: - apache2: - enabled: true - skip: false - running: true + - '::' + tcp:9000: + listening: true + ip: + - 127.0.0.1 user: www-data: exists: true - uid: 33 - gid: 33 + uid: 102 + gid: 82 groups: - www-data - home: /var/www - shell: /usr/sbin/nologin + home: /var/www/ + shell: /sbin/nologin group: www-data: exists: true - gid: 33 + gid: 82 command: artisan_env: - exec: php artisan env + exec: php /var/www/html/artisan env exit-status: 0 stdout: ['/production/'] stderr: [] timeout: 0 -process: - apache2: - running: true http: http://localhost/sw.js: status: 200 diff --git a/koel-entrypoint b/koel-entrypoint index cf21cd4..b78bf18 100755 --- a/koel-entrypoint +++ b/koel-entrypoint @@ -1,10 +1,35 @@ -#!/bin/bash +#!/bin/sh set -e # Change to program root directory. cd /var/www/html -# Run the next entrypoint in the chain. -echo "running docker-php-entrypoint with arguments $@" -docker-php-entrypoint $@ +# Make sure all the cache folders exist +echo "Creating cache directories if needed..." +mkdir -p /cache/img/artists \ + && mkdir -p /cache/img/avatars \ + && mkdir -p /cache/img/covers \ + && mkdir -p /cache/img/playlists \ + && mkdir -p /cache/img/radio-stations \ + && chown -R www-data:www-data /cache + +# start the cron daemon +echo "Starting cron daemon..." +crond + +echo "Starting php-fpm..." +php-fpm83 + +/usr/sbin/httpd -DFOREGROUND & + +# start apache, but background it while we run the doctor + +su -s '/bin/sh' -c "/usr/local/bin/koel-init" www-data + +# Run the actual passed start command +$@ + +#wait for all background processes to terminate +wait + diff --git a/koel-init b/koel-init new file mode 100755 index 0000000..b6274a9 --- /dev/null +++ b/koel-init @@ -0,0 +1,18 @@ +#!/bin/sh + +if [[ -z "${SKIP_INIT}" ]]; then + + if [[ -z "${OPTIMIZE_CONFIG}" ]]; then + echo "Config not optimized, if your config is locked in you can enable the OPTIMIZE_CONFIG option. Enabling this will optimize your config, but YOU WILL NOT BE ABLE TO MAKE CONFIG EDITS WITHOUT RESTARING THE CONTAINER" + else + echo "Optimizing config..." + php artisan config:cache + fi + + # Invoke the init script so database migrations run and the config is at least partially validated + echo "Running installer..." + php artisan koel:init --no-assets + php artisan koel:doctor +else + echo "Skipped init, koel might not be able to run if it is misconfigured or your database is out of date. This should not be used outside of debugging or manual initial setups!" +fi \ No newline at end of file