├── .dockerignore ├── .github ├── dependabot.yml └── workflows │ ├── build_and_publish.yml │ ├── build_image_develop.yml │ ├── build_image_release.yml │ └── build_on_request.yml ├── .gitignore ├── BUILD.md ├── Dockerfile ├── LICENSE ├── README.md ├── RUN.md ├── SETUP.md └── entrypoint.sh /.dockerignore: -------------------------------------------------------------------------------- 1 | # Ignore git and cache folders 2 | .git 3 | .cache 4 | 5 | # Ignore GitHub actions 6 | .github 7 | 8 | # Ignore all the markdown files 9 | *.md 10 | 11 | # Ignore secrets files 12 | db_root_pwd.txt 13 | db_user_pwd.txt 14 | 15 | # Ignore LICENSE file 16 | LICENSE -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "github-actions" 9 | directory: "/" 10 | schedule: 11 | interval: "weekly" 12 | -------------------------------------------------------------------------------- /.github/workflows/build_and_publish.yml: -------------------------------------------------------------------------------- 1 | name: Build and publish on workflow call 2 | 3 | on: 4 | workflow_call: 5 | inputs: 6 | appGitRefs: 7 | required: true 8 | type: string 9 | imgBuild: 10 | required: true 11 | type: string 12 | regName: 13 | required: true 14 | type: string 15 | regLogin: 16 | required: true 17 | type: string 18 | secrets: 19 | REGISTRY_TOKEN: 20 | description: docker registry access token 21 | required: true 22 | 23 | jobs: 24 | build: 25 | runs-on: ubuntu-latest 26 | steps: 27 | - 28 | name: Checkout github repository 29 | uses: actions/checkout@v4 30 | with: 31 | repository: ${{ vars.DOCKER_REPOSITORY }} 32 | ref: ${{ inputs.imgBuild }} 33 | - 34 | name: Setup QEMU 35 | uses: docker/setup-qemu-action@v3 36 | with: 37 | platforms: 'amd64,arm64,arm' 38 | - 39 | name: Setup Docker buildx 40 | uses: docker/setup-buildx-action@v3 41 | - 42 | name: Get the docker image metadata 43 | id: get_meta 44 | run: | 45 | appVersion=$(basename ${{ inputs.appGitRefs }}) 46 | echo "appVersion=$appVersion" >> $GITHUB_OUTPUT 47 | - 48 | name: Set the docker image metadata 49 | id: set_meta 50 | uses: docker/metadata-action@v5 51 | with: 52 | images: ${{ inputs.regLogin }}/librebooking 53 | tags: | 54 | type=raw,value=${{ steps.get_meta.outputs.appVersion }},suffix=-${{ inputs.imgBuild }} 55 | type=raw,value=${{ steps.get_meta.outputs.appVersion }} 56 | - 57 | name: Log into registry 58 | uses: docker/login-action@v3 59 | with: 60 | registry: ${{ inputs.regName }} 61 | username: ${{ inputs.regLogin }} 62 | password: ${{ secrets.REGISTRY_TOKEN }} 63 | - 64 | name: Build and push Docker image 65 | id: build-and-push 66 | uses: docker/build-push-action@v6 67 | with: 68 | context: . 69 | platforms: linux/amd64,linux/arm64,linux/arm/v7 70 | build-args: | 71 | VERSION_PHP=${{ vars.VERSION_PHP }} 72 | VERSION_COMPOSER=${{ vars.VERSION_COMPOSER }} 73 | APP_GH_REF=${{ inputs.appGitRefs }} 74 | tags: ${{ steps.set_meta.outputs.tags }} 75 | push: true 76 | -------------------------------------------------------------------------------- /.github/workflows/build_image_develop.yml: -------------------------------------------------------------------------------- 1 | name: Build develop image 2 | 3 | on: 4 | schedule: 5 | - cron: '0 1 * * *' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | build-develop: 10 | uses: ./.github/workflows/build_and_publish.yml 11 | with: 12 | appGitRefs: develop 13 | imgBuild: ${{ vars.IMAGE_BUILD }} 14 | regName: ${{ vars.REGISTRY_URL }} 15 | regLogin: ${{ vars.REGISTRY_LOGIN }} 16 | secrets: 17 | REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} 18 | -------------------------------------------------------------------------------- /.github/workflows/build_image_release.yml: -------------------------------------------------------------------------------- 1 | name: Build release image 2 | 3 | on: 4 | schedule: 5 | - cron: '0 1 * * 6' 6 | workflow_dispatch: 7 | 8 | jobs: 9 | build-stable: 10 | uses: ./.github/workflows/build_and_publish.yml 11 | with: 12 | appGitRefs: ${{ vars.VERSION_LIBREBOOKING }} 13 | imgBuild: ${{ vars.IMAGE_BUILD }} 14 | regName: ${{ vars.REGISTRY_URL }} 15 | regLogin: ${{ vars.REGISTRY_LOGIN }} 16 | secrets: 17 | REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} 18 | -------------------------------------------------------------------------------- /.github/workflows/build_on_request.yml: -------------------------------------------------------------------------------- 1 | name: Build and publish on request 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | appGitRefs: 7 | required: true 8 | description: 'Librebooking/app version' 9 | default: 'develop' 10 | imgBuild: 11 | required: true 12 | description: 'Librebooking/docker version' 13 | default: '2.5.0' 14 | regName: 15 | required: true 16 | description: 'Registry name' 17 | default: 'docker.io' 18 | regLogin: 19 | required: true 20 | description: 'Registry login' 21 | default: 'librebooking' 22 | 23 | jobs: 24 | call-builder: 25 | uses: ./.github/workflows/build_and_publish.yml 26 | with: 27 | appGitRefs: ${{ inputs.appGitRefs }} 28 | imgBuild: ${{ inputs.imgBuild }} 29 | regName: ${{ inputs.regName }} 30 | regLogin: ${{ inputs.regLogin }} 31 | secrets: 32 | REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }} 33 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LibreBooking/docker/48c73a8e6d36f36d74a88afe73bb64443e971a3d/.gitignore -------------------------------------------------------------------------------- /BUILD.md: -------------------------------------------------------------------------------- 1 | You have 2 ways to get the docker image on your host: 2 | 1. Getting the image from the docker's hub 3 | 1. Building the image yourself 4 | 5 | # Getting the image from the docker's hub 6 | 7 | This is the easiest and fastest way. 8 | ``` 9 | # Stable release 10 | docker image pull librebooking/librebooking:2.8.6.2 11 | 12 | # Development branch 13 | docker image pull librebooking/librebooking:develop 14 | ``` 15 | 16 | # Building the image 17 | 18 | You have 3 ways to build the docker image. 19 | 20 | Regardless of the chosen option, you need to clone this repository: 21 | ``` 22 | git clone https://github.com/librebooking/docker 23 | ``` 24 | 25 | ## Option-1 26 | 27 | | Item | Value | 28 | | --- | --- | 29 | | Builder | On your host | 30 | | Image | On your host | 31 | | Platform | your host architecture | 32 | 33 | Run the following commands on your host: 34 | ``` 35 | # Set the application release (ex: develop or 2.8.6.2) 36 | LB_RELEASE=develop 37 | if [ "${LB_RELEASE}" == "develop" ]; then 38 | APP_GH_REF="refs/heads/${LB_RELEASE}" 39 | else 40 | APP_GH_REF="refs/tags/${LB_RELEASE}" 41 | fi 42 | 43 | # Build the docker image 44 | docker buildx build \ 45 | --build-arg PHP_VERSION=8 \ 46 | --build-arg APP_GH_REF=${APP_GH_REF} \ 47 | --tag librebooking/librebooking:${LB_RELEASE} \ 48 | --output type=docker \ 49 | . 50 | ``` 51 | 52 | ## Option-2 53 | 54 | | Item | Value | 55 | | --- | --- | 56 | | Builder | On your host | 57 | | Image | On hub.docker.com | 58 | | Platform | linux/amd64,linux/arm64,linux/arm/v7 | 59 | 60 | Run the following commands on your host: 61 | ``` 62 | # Set the application release (ex: develop or 2.8.6.2) 63 | LB_RELEASE=develop 64 | if [ "${LB_RELEASE}" == "develop" ]; then 65 | APP_GH_REF="refs/heads/${LB_RELEASE}" 66 | else 67 | APP_GH_REF="refs/tags/${LB_RELEASE}" 68 | fi 69 | 70 | # Log to the docker hub 71 | docker login --username 72 | 73 | # If needed, create a docker-container based build instance 74 | docker buildx create --driver docker-container --use 75 | 76 | # Build the docker image 77 | docker buildx build \ 78 | --build-arg PHP_VERSION=8 \ 79 | --build-arg APP_GH_REF=${APP_GH_REF} \ 80 | --tag ${REGISTRY_USER}/librebooking:${LB_RELEASE} \ 81 | --output type=registry \ 82 | --platform=linux/amd64,linux/arm64,linux/arm/v7 \ 83 | . 84 | ``` 85 | 86 | ## Option-3 87 | 88 | | Item | Value | 89 | | --- | --- | 90 | | Builder | On github.com | 91 | | Image | On hub.docker.com | 92 | | Platform | linux/amd64,linux/arm64,linux/arm/v7 | 93 | 94 | 1. Create a github secret, called `REGISTRY_TOKEN`, to store your registry personal access token 95 | 1. Run the github action `Build and publish docker images` from the latest repository tag 96 | 1. Click on `Run workflow`. Then click on `Branch: develop` and select instead the latest version tag 97 | 1. Specify the librebooking application github reference (ex: refs/tags/2.8.6.2 or refs/heads/develop) 98 | 1. Click on the `Run workflow` button 99 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | ARG VERSION_PHP 2 | ARG VERSION_COMPOSER 3 | 4 | FROM composer:${VERSION_COMPOSER} AS comp 5 | FROM php:${VERSION_PHP}-apache 6 | 7 | # Labels 8 | LABEL org.opencontainers.image.title="LibreBooking" 9 | LABEL org.opencontainers.image.description="LibreBooking as a container" 10 | LABEL org.opencontainers.image.url="https://github.com/librebooking/docker" 11 | LABEL org.opencontainers.image.source="https://github.com/librebooking/docker" 12 | LABEL org.opencontainers.image.licenses="GPL-3.0" 13 | LABEL org.opencontainers.image.authors="robin.alexander@netplus.ch" 14 | 15 | # Set entrypoint 16 | COPY entrypoint.sh /usr/local/bin/ 17 | RUN chmod +x /usr/local/bin/entrypoint.sh 18 | 19 | # Install composer 20 | COPY --from=comp /usr/bin/composer /usr/bin/composer 21 | 22 | # Update and install required debian packages 23 | ENV DEBIAN_FRONTEND=noninteractive 24 | RUN set -ex; \ 25 | apt-get update; \ 26 | apt-get upgrade --yes; \ 27 | apt-get install --yes --no-install-recommends \ 28 | git \ 29 | libjpeg-dev \ 30 | libldap-dev \ 31 | libpng-dev \ 32 | unzip; \ 33 | apt-get clean; \ 34 | rm -rf /var/lib/apt/lists/* 35 | 36 | # Customize apache and php settings 37 | RUN set -ex; \ 38 | cp "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"; \ 39 | { \ 40 | echo 'RemoteIPHeader X-Real-IP'; \ 41 | echo 'RemoteIPInternalProxy 10.0.0.0/8'; \ 42 | echo 'RemoteIPInternalProxy 172.16.0.0/12'; \ 43 | echo 'RemoteIPInternalProxy 192.168.0.0/16'; \ 44 | } > /etc/apache2/conf-available/remoteip.conf; \ 45 | a2enconf remoteip; \ 46 | a2enmod rewrite; \ 47 | a2enmod headers; \ 48 | a2enmod remoteip; \ 49 | docker-php-ext-configure gd --with-jpeg; \ 50 | docker-php-ext-install mysqli gd ldap; \ 51 | pecl install timezonedb; \ 52 | docker-php-ext-enable timezonedb; 53 | 54 | # Get and customize librebooking 55 | USER www-data 56 | ARG APP_GH_REF 57 | RUN set -ex; \ 58 | curl \ 59 | --fail \ 60 | --silent \ 61 | --location https://api.github.com/repos/librebooking/app/tarball/${APP_GH_REF} \ 62 | | tar --extract --gzip --directory=/var/www/html --strip-components=1; \ 63 | if [ -f /var/www/html/composer.json ]; then \ 64 | composer install; \ 65 | fi; \ 66 | sed \ 67 | -i /var/www/html/database_schema/create-user.sql \ 68 | -e "s:^DROP USER ':DROP USER IF EXISTS ':g" \ 69 | -e "s:booked_user:schedule_user:g" \ 70 | -e "s:localhost:%:g"; \ 71 | if ! [ -d /var/www/html/tpl_c ]; then \ 72 | mkdir /var/www/html/tpl_c; \ 73 | fi 74 | 75 | # Final customization 76 | USER root 77 | RUN set -ex; \ 78 | touch /app.log; \ 79 | chown www-data:www-data /app.log; \ 80 | mkdir /config 81 | 82 | # Environment 83 | WORKDIR / 84 | VOLUME /config 85 | ENTRYPOINT ["/usr/local/bin/entrypoint.sh"] 86 | CMD ["apache2-foreground"] 87 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # What is librebooking 2 | [Librebooking](https://github.com/librebooking/app) is a simple powerful scheduling solution for any organization, forked from [Booked](https://www.bookedscheduler.com/). 3 | 4 | # Project goal 5 | This project implements the librebooking web application as a docker image. 6 | 7 | The image contains the apache web server and the librebooking application files. 8 | It needs to be linked to a MariaDB database container. 9 | 10 | # Table of contents 11 | 1. [Get or build the docker image](BUILD.md) 12 | 1. [Run the docker container](RUN.md) 13 | 1. [Setup the application](SETUP.md) 14 | -------------------------------------------------------------------------------- /RUN.md: -------------------------------------------------------------------------------- 1 | # How to run the docker image 2 | The image contains the apache web server and the librebooking application files. 3 | It needs to be linked to a MariaDB database container. 4 | 5 | ## Environment variables 6 | Environment variables are used on first invocation of the container 7 | (when the file config/config.php does not yet exist) 8 | 9 | | Env | Default | Example | Required | config.php settings | 10 | | - | - | - | - | - | 11 | | `LB_DB_HOST` | - | lb-db | **Yes** | ['settings']['database']['hostspec'] | 12 | | `LB_DB_NAME` | - | librebooking | **Yes** | ['settings']['database']['name'] | 13 | | `LB_DB_USER` | - | lb_user | **Yes** | ['settings']['database']['user'] | 14 | | `LB_DB_USER_PWD` | - | myPassw0rd | **Yes** | ['settings']['database']['password'] | 15 | | `LB_INSTALL_PWD` | - | installPWD | **Yes** | ['settings']['install.password'] | 16 | | `TZ` | - | Europe/Zurich | **Yes** | ['settings']['default.timezone'] | 17 | | `LB_LOG_FOLDER` | /var/log/librebooking | | **No** | ['settings']['logging']['folder'] | 18 | | `LB_LOG_LEVEL` | none | debug | **No** | ['settings']['logging']['level'] | 19 | | `LB_LOG_SQL` | false | true | **No** | ['settings']['logging']['sql'] | 20 | | `LB_ENV` | production | dev | **No** | N/A - Used to initialize file config.php | 21 | | `LB_PATH` | - | book | **No** | N/A - URL path prefix (usually none) | 22 | 23 | ## Development environment: using the command line interface 24 | This simple setup is meant for testing the application within your private network. 25 | 26 | Create the container network 27 | ``` 28 | docker network create mynet 29 | ``` 30 | 31 | Run the database 32 | ``` 33 | docker run \ 34 | --name librebooking-db \ 35 | --detach \ 36 | --network mynet \ 37 | --volume librebooking-db:/config \ 38 | --env PUID=1000 \ 39 | --env PGID=1000 \ 40 | --env TZ=Europe/Zurich \ 41 | --env MYSQL_ROOT_PASSWORD=your_Mariadb_root_password \ 42 | linuxserver/mariadb:10.6.13 43 | ``` 44 | 45 | Run librebooking 46 | ``` 47 | docker run \ 48 | --name librebooking \ 49 | --detach \ 50 | --network mynet \ 51 | --publish 80:80 \ 52 | --volume librebooking-conf:/config \ 53 | --env LB_DB_NAME=librebooking \ 54 | --env LB_DB_USER=lb_user \ 55 | --env LB_DB_USER_PWD=your_Mariadb_user_password \ 56 | --env LB_DB_HOST=librebooking-db \ 57 | --env LB_INSTALL_PWD=your_Librebooking_installation_password \ 58 | --env LB_ENV=dev \ 59 | --env LB_LOG_FOLDER=/var/log/librebooking \ 60 | --env LB_LOG_LEVEL=debug \ 61 | --env LB_LOG_SQL=false \ 62 | --env TZ=Europe/Zurich \ 63 | librebooking/librebooking:develop 64 | ``` 65 | 66 | ## Development environment: using docker compose 67 | This simple setup is meant for testing the application within your private network. 68 | 69 | Create a `docker-compose.yml` file from the following sample and adapt the 70 | value of the environment variables to your needs: 71 | ``` 72 | version: "3.7" 73 | 74 | services: 75 | db: 76 | image: linuxserver/mariadb:10.6.13 77 | restart: always 78 | networks: 79 | - mynet 80 | volumes: 81 | - db_conf:/config 82 | environment: 83 | - PUID=1000 84 | - PGID=1000 85 | - TZ=Europe/Zurich 86 | - MYSQL_ROOT_PASSWORD=your_Mariadb_root_password 87 | app: 88 | image: librebooking/librebooking:develop 89 | restart: always 90 | depends_on: 91 | - db 92 | networks: 93 | - mynet 94 | ports: 95 | - "80:80" 96 | volumes: 97 | - app_conf:/config 98 | environment: 99 | - LB_DB_NAME=librebooking 100 | - LB_DB_USER=lb_user 101 | - LB_DB_USER_PWD=your_Mariadb_user_password 102 | - LB_DB_HOST=db 103 | - LB_INSTALL_PWD=your_Librebooking_installation_password 104 | - LB_ENV=dev 105 | - LB_LOG_FOLDER=/var/log/librebooking 106 | - LB_LOG_LEVEL=debug 107 | - LB_LOG_SQL=false 108 | - TZ=Europe/Zurich 109 | 110 | volumes: 111 | db_conf: 112 | app_conf: 113 | 114 | networks: 115 | mynet: 116 | ``` 117 | 118 | Start the application with the following command: 119 | ``` 120 | docker-compose up --detach 121 | ``` 122 | 123 | ## Production environment: using docker compose 124 | This setup is meant for accessing the application from the internet. It features: 125 | - A reverse proxy based on nginx that automatically handle certificates 126 | - The usage of secrets to pass passwords to the docker container 127 | - A librebooking service accessible without a URL-path (ex: https://librebooking.your-domain.com) 128 | - A librebooking service accessible with a URL-path (ex: https://your-domain.com/book) 129 | 130 | Create a `docker-compose.yml` file from the following sample and adapt the value of the environment variables to your needs: 131 | 132 | ``` 133 | version: "3.7" 134 | 135 | services: 136 | proxy: 137 | image: nginxproxy/nginx-proxy 138 | restart: always 139 | networks: 140 | - mynet 141 | ports: 142 | - 80:80 143 | - 443:443 144 | volumes: 145 | - proxy_certs:/etc/nginx/certs 146 | - proxy_html:/usr/share/nginx/html 147 | - /var/run/docker.sock:/tmp/docker.sock:ro 148 | acme: 149 | image: nginxproxy/acme-companion 150 | restart: always 151 | depends_on: 152 | - proxy 153 | networks: 154 | - mynet 155 | volumes_from: 156 | - proxy 157 | volumes: 158 | - acme_acme:/etc/acme.sh 159 | - /var/run/docker.sock:/var/run/docker.sock:ro 160 | environment: 161 | - DEFAULT_EMAIL=colisee@hotmail.com 162 | db: 163 | image: linuxserver/mariadb:10.6.13 164 | restart: always 165 | networks: 166 | - mynet 167 | volumes: 168 | - db_conf:/config 169 | environment: 170 | - PUID=1000 171 | - PGID=1000 172 | - TZ=Europe/Zurich 173 | - FILE__MYSQL_ROOT_PASSWORD=/run/secrets/db_root_pwd 174 | secrets: 175 | - db_root_pwd 176 | - db_user_pwd 177 | lb1: 178 | image: librebooking/librebooking:2.8.6.2 179 | restart: always 180 | depends_on: 181 | - db 182 | networks: 183 | - mynet 184 | volumes: 185 | - lb1_conf:/config 186 | environment: 187 | - LB_DB_NAME=lb1 188 | - LB_INSTALL_PWD_FILE=/run/secrets/lb_install_pwd 189 | - LB_DB_USER=lb1 190 | - LB_DB_USER_PWD_FILE=/run/secrets/lb_user_pwd 191 | - LB_DB_HOST=db 192 | - LB_ENV=production 193 | - LB_LOG_FOLDER=/var/log/librebooking 194 | - LB_LOG_LEVEL=error 195 | - LB_LOG_SQL=false 196 | - LB_PATH=lb1 197 | - TZ=Europe/Zurich 198 | - VIRTUAL_HOST=your_host_com 199 | - VIRTUAL_PATH=/your_path 200 | - LETSENCRYPT_HOST=your_host_com 201 | secrets: 202 | - lb_install_pwd 203 | - lb_user_pwd 204 | lb2: 205 | image: librebooking/librebooking:2.8.6.2 206 | restart: always 207 | depends_on: 208 | - db 209 | networks: 210 | - mynet 211 | volumes: 212 | - lb2_conf:/config 213 | environment: 214 | - LB_DB_NAME=lb2 215 | - LB_INSTALL_PWD_FILE=/run/secrets/lb_install_pwd 216 | - LB_DB_USER=lb2 217 | - LB_DB_USER_PWD_FILE=/run/secrets/lb_user_pwd 218 | - LB_DB_HOST=db 219 | - LB_ENV=production 220 | - LB_LOG_FOLDER=/var/log/librebooking 221 | - LB_LOG_LEVEL=error 222 | - LB_LOG_SQL=false 223 | - TZ=Europe/Zurich 224 | - VIRTUAL_HOST=your_host_com 225 | - LETSENCRYPT_HOST=your_host_com 226 | secrets: 227 | - lb_install_pwd 228 | - lb_user_pwd 229 | 230 | volumes: 231 | proxy_certs: 232 | proxy_html: 233 | acme_acme: 234 | db_conf: 235 | lb1_conf: 236 | lb2_conf: 237 | 238 | networks: 239 | mynet: 240 | 241 | secrets: 242 | db_root_pwd: 243 | file: ./pwd_db_root.txt 244 | db_user_pwd: 245 | file: ./pwd_db_user.txt 246 | lb_user_pwd: 247 | file: ./pwd_db_user.txt 248 | lb_install_pwd: 249 | file: ./pwd_lb_inst.txt 250 | ``` 251 | 252 | Set the secrets with the following commands: 253 | ``` 254 | echo -n 'your_Mariadb_root_password' > pwd_db_root.txt; 255 | echo -n 'your_Mariadb_user_password' > pwd_db_user.txt; 256 | echo -n 'your_Librebooking_installation_password' > pwd_lb_inst.txt; 257 | ``` 258 | Start the application with the following command: 259 | ``` 260 | docker-compose up --detach 261 | ``` 262 | -------------------------------------------------------------------------------- /SETUP.md: -------------------------------------------------------------------------------- 1 | # How to setup the application 2 | 3 | ## First-time fresh install 4 | 5 | ### Database initialization 6 | 1. Point your web browser to `/install` or `//install` 7 | (if you are using a custom URL-path) 8 | - Enter the installation password (docker variable `LB_INSTALL_PWD`) 9 | - Enter the database root user: `root` 10 | - Enter the database root password (docker variable `LB_DB_USER_PWD`) 11 | - Select `Create the database` 12 | - Select `Create the database user` 13 | - Click on the register link, at the bottom of the web page 14 | - Fill the register form for the application administrator 15 | - Click on the button `Register` 16 | 17 | ### Application configuration 18 | 1. Point your web browser to `` or `/` 19 | if you are using a reverse-proxy 20 | 1. Login with your application administrator profile 21 | 1. Configure the web application 22 | 23 | ## Upgrade from a previous application version 24 | 1. Stop the service 25 | ``` 26 | docker-compose down 27 | ``` 28 | 1. Change the image name inside your `docker-compose.yml` file 29 | 1. Restart the service 30 | ``` 31 | docker-compose up --detach 32 | ``` 33 | 1. Upgrade the application database by accessing `/install/configure.php` 34 | or `//install/configure.php` 35 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -ex 4 | 5 | # Constants 6 | readonly DFT_LOG_FLR="/var/log/librebooking" 7 | readonly DFT_LOG_LEVEL="none" 8 | readonly DFT_LOG_SQL=false 9 | readonly DFT_LB_ENV="production" 10 | readonly DFT_LB_PATH="" 11 | 12 | file_env() { 13 | local var="$1" 14 | local fileVar="${var}_FILE" 15 | local def="${2:-}" 16 | local varValue=$(env | grep -E "^${var}=" | sed -E -e "s/^${var}=//") 17 | local fileVarValue=$(env | grep -E "^${fileVar}=" | sed -E -e "s/^${fileVar}=//") 18 | if [ -n "${varValue}" ] && [ -n "${fileVarValue}" ]; then 19 | echo >&2 "error: both $var and $fileVar are set (but are exclusive)" 20 | exit 1 21 | fi 22 | if [ -n "${varValue}" ]; then 23 | export "$var"="${varValue}" 24 | elif [ -n "${fileVarValue}" ]; then 25 | export "$var"="$(cat "${fileVarValue}")" 26 | elif [ -n "${def}" ]; then 27 | export "$var"="$def" 28 | fi 29 | unset "$fileVar" 30 | } 31 | 32 | # Exit if incompatible mount (images prior to V2) 33 | if [ "$(mount | grep /var/www/html)" = "/var/www/html" ]; then 34 | echo "The volume must be mapped to container directory /config" >2 35 | exit 1 36 | fi 37 | 38 | # Initialize variables 39 | file_env LB_INSTALL_PWD 40 | file_env LB_DB_USER_PWD 41 | 42 | LB_LOG_FOLDER=${LB_LOG_FOLDER:-${DFT_LOG_FLR}} 43 | LB_LOG_LEVEL=${LB_LOG_LEVEL:-${DFT_LOG_LEVEL}} 44 | LB_LOG_SQL=${LB_LOG_SQL:-${DFT_LOG_SQL}} 45 | LB_ENV=${LB_ENV:-${DFT_LB_ENV}} 46 | LB_PATH=${LB_PATH:-${DFT_LB_PATH}} 47 | 48 | # If volume was used with images older than v2, then archive useless files 49 | pushd /config 50 | if [ -d Web ]; then 51 | mkdir archive 52 | chown www-data:www-data archive 53 | mv $(ls --ignore=archive) archive 54 | if [ -f archive/config/config.php ]; then 55 | cp archive/config/config.php config.php 56 | chown www-data:www-data config.php 57 | fi 58 | fi 59 | popd 60 | 61 | # No configuration file inside directory /config 62 | if ! [ -f /config/config.php ]; then 63 | echo "Initialize file config.php" 64 | if [ "${LB_ENV}" = "dev" ]; then 65 | cp /var/www/html/config/config.devel.php /config/config.php 66 | else 67 | cp /var/www/html/config/config.dist.php /config/config.php 68 | fi 69 | chown www-data:www-data /config/config.php 70 | sed \ 71 | -i /config/config.php \ 72 | -e "s:\(\['registration.captcha.enabled'\]\) = 'true':\1 = 'false':" \ 73 | -e "s:\(\['database'\]\['user'\]\) = '.*':\1 = '${LB_DB_USER}':" \ 74 | -e "s:\(\['database'\]\['password'\]\) = '.*':\1 = '${LB_DB_USER_PWD}':" \ 75 | -e "s:\(\['database'\]\['name'\]\) = '.*':\1 = '${LB_DB_NAME}':" 76 | fi 77 | 78 | # Link the configuration file 79 | if ! [ -f /var/www/html/config/config.php ]; then 80 | ln -s /config/config.php /var/www/html/config/config.php 81 | fi 82 | 83 | # Set secondary configuration settings 84 | sed \ 85 | -i /config/config.php \ 86 | -e "s:\(\['install.password'\]\) = '.*':\1 = '${LB_INSTALL_PWD}':" \ 87 | -e "s:\(\['default.timezone'\]\) = '.*':\1 = '${TZ}':" \ 88 | -e "s:\(\['database'\]\['hostspec'\]\) = '.*':\1 = '${LB_DB_HOST}':" \ 89 | -e "s:\(\['logging'\]\['folder'\]\) = '.*':\1 = '${LB_LOG_FOLDER}':" \ 90 | -e "s:\(\['logging'\]\['level'\]\) = '.*':\1 = '${LB_LOG_LEVEL}':" \ 91 | -e "s:\(\['logging'\]\['sql'\]\) = '.*':\1 = '${LB_LOG_SQL}':" 92 | 93 | # Create the plugins configuration file inside the volume 94 | for source in $(find /var/www/html/plugins -type f -name "*dist*"); do 95 | target=$(echo "${source}" | sed -e "s/.dist//") 96 | if ! [ -f "/config/$(basename ${target})" ]; then 97 | cp --no-clobber "${source}" "/config/$(basename ${target})" 98 | chown www-data:www-data "/config/$(basename ${target})" 99 | fi 100 | if ! [ -f ${target} ]; then 101 | ln -s "/config/$(basename ${target})" "${target}" 102 | fi 103 | done 104 | 105 | # Set timezone 106 | if test -f /usr/share/zoneinfo/${TZ}; then 107 | ln -sf /usr/share/zoneinfo/${TZ} /etc/localtime 108 | 109 | INI_FILE="/usr/local/etc/php/conf.d/librebooking.ini" 110 | echo "[date]" > ${INI_FILE} 111 | echo "date.timezone=\"${TZ}\"" >> ${INI_FILE} 112 | fi 113 | 114 | # Get log directory 115 | log_flr=$(grep \ 116 | -e "\['logging'\]\['folder'\]" \ 117 | /var/www/html/config/config.php \ 118 | | cut -d " " -f3 | cut -d "'" -f2) 119 | log_flr=${log_flr:-${DFT_LOG_FLR}} 120 | 121 | # Missing log directory 122 | if ! test -d "${log_flr}"; then 123 | mkdir -p "${log_flr}" 124 | chown -R www-data:www-data "${log_flr}" 125 | fi 126 | 127 | # Missing log file 128 | if ! test -f "${log_flr}/app.log"; then 129 | touch "${log_flr}/app.log" 130 | chown www-data:www-data "${log_flr}/app.log" 131 | fi 132 | 133 | # A URL path prefix was set 134 | if ! test -z "${LB_PATH}"; then 135 | ## Set server document root 1 directory up 136 | sed \ 137 | -i /etc/apache2/sites-enabled/000-default.conf \ 138 | -e "s:/var/www/html:/var/www:" 139 | 140 | ## Rename the html directory as the URL prefix 141 | ln -s /var/www/html "/var/www/${LB_PATH}" 142 | chown www-data:www-data "/var/www/${LB_PATH}" 143 | 144 | ## Adapt the .htaccess file 145 | sed \ 146 | -i /var/www/${LB_PATH}/.htaccess \ 147 | -e "s:\(RewriteCond .*\)/Web/:\1\.\*/Web/:" \ 148 | -e "s:\(RewriteRule .*\) /Web/:\1 /${LB_PATH}/Web/:" 149 | fi 150 | 151 | # Run the apache server 152 | exec "$@" 153 | --------------------------------------------------------------------------------