From 8744d670a6a253c2db6e27334e6ef3fc8c29962c Mon Sep 17 00:00:00 2001 From: Hardware Date: Mon, 18 Jul 2016 08:35:38 +0200 Subject: [PATCH] docs(): update readme --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 73 ++++++++++---------- 2 files changed, 238 insertions(+), 36 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9ec14cb --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2016 Mondedie.fr + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 36db49f..cf2e5e8 100644 --- a/README.md +++ b/README.md @@ -4,60 +4,59 @@ ### What is this ? -Flarum is the next-generation forum software that makes online discussion fun. It's simple, fast, and free. +Flarum is the next-generation forum software that makes online discussion fun. It's simple, fast, and free. http://flarum.org/ ### Features +- Lightweight & secure image - Based on Alpine Linux 3.4 with **nginx** and **PHP 7** - Latest Flarum Beta (v0.1.0-beta.5) - MySQL/Mariadb driver +- OPCache extension configured ### Build-time variables -- **VERSION** : Version of flarum (default *v0.1.0-beta.5*) +- **VERSION** = Version of flarum (default: *v0.1.0-beta.5*) ### Environment variables -- **GID** = Flarum user id (*optional*, default: 991) -- **UID** = Flarum group id (*optional*, default: 991) -- **FORUM_URL** = Forum URL (**required**) -- **DB_HOST** = MariaDB instance ip/hostname (*optional*, default: mariadb) -- **DB_USER** = MariaDB database username (*optional*, default: flarum) -- **DB_NAME** = MariaDB database name (*optional*, default: flarum) -- **DB_PASS** = MariaDB database password (**required**) -- **MAIL_FROM** = Mail 'from address' (*optional*, default: null) -- **MAIL_HOST** = Mail server FQDN (*optional*, default: null) -- **MAIL_PORT** = Mail server smtp port (*optional*, default: null) -- **MAIL_ENCR** = Encryption protocol (*optional*, default: null) -- **MAIL_USER** = Username (*optional*, default: null) -- **MAIL_PASS** = Password (*optional*, default: null) - -#### Mail settings example : - -``` -MAIL_FROM = noreply@domain.tld -MAIL_HOST = mail.domain.tld -MAIL_PORT = 25 or 465 or 587 -MAIL_ENCR = ssl (465) or tls (587) -MAIL_USER = contact@domain.tld -MAIL_PASS = xxxxxxxx -``` +| Variable | Description | Type | Default value | +| -------- | ----------- | ---- | ------------- | +| **GID** | Flarum user id | *optional* | 991 +| **UID** | Flarum group id | *optional* | 991 +| **FORUM_URL** | Forum URL | **required** | none +| **DB_HOST** | MariaDB instance ip/hostname | *optional* | mariadb +| **DB_USER** | MariaDB database username | *optional* | flarum +| **DB_NAME** | MariaDB database name | *optional* | flarum +| **DB_PASS** | MariaDB database password | **required** | none +| **MAIL_FROM** | Mail 'from address' | *optional* | none +| **MAIL_HOST** | Mail server FQDN | *optional* | none +| **MAIL_PORT** | Mail server smtp port | *optional* | none +| **MAIL_ENCR** | Encryption protocol, tls (587) or ssl (465) | *optional* | none +| **MAIL_USER** | Username | *optional* | none +| **MAIL_PASS** | Password | *optional* | none ### Volume * /flarum/www : Flarum directory -### Installation +## Installation + +#### 1 - Pull flarum image ``` docker pull mondedie/flarum +``` +#### 2 - Create environment file + +``` mkdir -p ~/.config/flarum touch ~/.config/flarum/.env chmod 600 ~/.config/flarum/.env ``` -Create an `.env` file with your environment variables +Create an `.env` file with your environment variables : ```bash # vim ~/.config/flarum/.env @@ -80,9 +79,9 @@ MAIL_USER=admin@domain.tld # Optional MAIL_PASS=xxxxxxxx # Optional ``` -### Docker-compose +#### 3 - Docker-compose.yml -#### Docker-compose.yml +Adapt to your needs : ``` flarum: @@ -106,16 +105,18 @@ mariadb: - MYSQL_PASSWORD=yyyyyyyy ``` -#### Run ! +#### 4 - Reverse proxy setup + +See : https://github.com/mondediefr/flarum/wiki/Reverse-proxy-example + +#### 5 - Done, congratulation ! :tada: + +You can now run Flarum : ``` docker-compose up -d ``` -### Reverse proxy example - -https://github.com/mondediefr/flarum/wiki/Reverse-proxy-example - ### Default account * **Username** : *admin* @@ -125,6 +126,6 @@ https://github.com/mondediefr/flarum/wiki/Reverse-proxy-example The main configuration file is located here : **/mnt/docker/flarum/app/config.php** -### Screenshot +### Screenshot ![flarum](https://i.imgur.com/teqg3od.pngP)