From d6902e9d255a646e511e8af7401d1cb39e03598d Mon Sep 17 00:00:00 2001 From: Paul Sinclair Date: Sun, 14 Apr 2019 18:21:05 -0400 Subject: [PATCH] :tada: Inital Commit --- .editorconfig | 19 ++ .gitattributes | 3 + .github/CODEOWNERS | 4 + .github/ISSUE_TEMPLATE.md | 20 ++ .github/PULL_REQUEST_TEMPLATE.md | 9 + .github/autolabeler.yml | 2 + .github/config.yml | 50 +++++ .github/invite-contributors.yml | 10 + .github/lock.yml | 20 ++ .github/move.yml | 20 ++ .github/no-response.yml | 13 ++ .github/potential-duplicates.yml | 14 ++ .github/settings.yml | 150 ++++++++++++++ .github/stale.yml | 61 ++++++ .github/support.yml | 22 +++ .gitignore | 0 .gitlab-ci.yml | 14 ++ .mdlrc | 1 + .yamllint | 66 +++++++ CODE_OF_CONDUCT.md | 74 +++++++ CONTRIBUTING.md | 29 +++ LICENSE.md | 21 ++ README.md | 186 ++++++++++++++++++ bookstack/.README.j2 | 66 +++++++ bookstack/Dockerfile | 76 +++++++ bookstack/build.json | 11 ++ bookstack/config.json | 38 ++++ .../rootfs/etc/cont-init.d/20-folders.sh | 29 +++ bookstack/rootfs/etc/cont-init.d/30-nginx.sh | 34 ++++ bookstack/rootfs/etc/cont-init.d/31-mysql.sh | 46 +++++ .../rootfs/etc/cont-init.d/32-bookstack.sh | 18 ++ bookstack/rootfs/etc/fix-attrs.d/31-mysql | 3 + bookstack/rootfs/etc/fix-attrs.d/33-bookstack | 3 + .../rootfs/etc/nginx/includes/mime.types | 96 +++++++++ bookstack/rootfs/etc/nginx/includes/php.conf | 5 + .../etc/nginx/includes/proxy_params.conf | 15 ++ .../rootfs/etc/nginx/includes/resolver.conf | 1 + .../etc/nginx/includes/server_params.conf | 6 + .../nginx/includes/server_params_local.conf | 3 + .../rootfs/etc/nginx/includes/ssl_params.conf | 9 + .../rootfs/etc/nginx/includes/upstream.conf | 3 + bookstack/rootfs/etc/nginx/lua/ha-auth.lua | 83 ++++++++ .../etc/nginx/modules/ndk_http.conf.old | 1 + .../etc/nginx/modules/ngx_http_lua.conf.old | 1 + bookstack/rootfs/etc/nginx/nginx.conf | 58 ++++++ .../etc/nginx/servers/direct-ssl.disabled | 17 ++ .../rootfs/etc/nginx/servers/direct.disabled | 12 ++ bookstack/rootfs/etc/php7/php-fpm.d/www.conf | 11 ++ bookstack/rootfs/etc/services.d/mysql/finish | 9 + bookstack/rootfs/etc/services.d/mysql/run | 13 ++ bookstack/rootfs/etc/services.d/nginx/finish | 9 + bookstack/rootfs/etc/services.d/nginx/run | 17 ++ .../rootfs/etc/services.d/php-fpm/finish | 9 + bookstack/rootfs/etc/services.d/php-fpm/run | 20 ++ bookstack/rootfs/var/www/bookstack/.env | 30 +++ renovate.json | 11 ++ 56 files changed, 1571 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/autolabeler.yml create mode 100644 .github/config.yml create mode 100644 .github/invite-contributors.yml create mode 100644 .github/lock.yml create mode 100644 .github/move.yml create mode 100644 .github/no-response.yml create mode 100644 .github/potential-duplicates.yml create mode 100644 .github/settings.yml create mode 100644 .github/stale.yml create mode 100644 .github/support.yml create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 .mdlrc create mode 100644 .yamllint create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 bookstack/.README.j2 create mode 100644 bookstack/Dockerfile create mode 100644 bookstack/build.json create mode 100644 bookstack/config.json create mode 100644 bookstack/rootfs/etc/cont-init.d/20-folders.sh create mode 100644 bookstack/rootfs/etc/cont-init.d/30-nginx.sh create mode 100644 bookstack/rootfs/etc/cont-init.d/31-mysql.sh create mode 100644 bookstack/rootfs/etc/cont-init.d/32-bookstack.sh create mode 100644 bookstack/rootfs/etc/fix-attrs.d/31-mysql create mode 100644 bookstack/rootfs/etc/fix-attrs.d/33-bookstack create mode 100644 bookstack/rootfs/etc/nginx/includes/mime.types create mode 100644 bookstack/rootfs/etc/nginx/includes/php.conf create mode 100644 bookstack/rootfs/etc/nginx/includes/proxy_params.conf create mode 100644 bookstack/rootfs/etc/nginx/includes/resolver.conf create mode 100644 bookstack/rootfs/etc/nginx/includes/server_params.conf create mode 100644 bookstack/rootfs/etc/nginx/includes/server_params_local.conf create mode 100644 bookstack/rootfs/etc/nginx/includes/ssl_params.conf create mode 100644 bookstack/rootfs/etc/nginx/includes/upstream.conf create mode 100644 bookstack/rootfs/etc/nginx/lua/ha-auth.lua create mode 100644 bookstack/rootfs/etc/nginx/modules/ndk_http.conf.old create mode 100644 bookstack/rootfs/etc/nginx/modules/ngx_http_lua.conf.old create mode 100644 bookstack/rootfs/etc/nginx/nginx.conf create mode 100644 bookstack/rootfs/etc/nginx/servers/direct-ssl.disabled create mode 100644 bookstack/rootfs/etc/nginx/servers/direct.disabled create mode 100644 bookstack/rootfs/etc/php7/php-fpm.d/www.conf create mode 100644 bookstack/rootfs/etc/services.d/mysql/finish create mode 100644 bookstack/rootfs/etc/services.d/mysql/run create mode 100644 bookstack/rootfs/etc/services.d/nginx/finish create mode 100644 bookstack/rootfs/etc/services.d/nginx/run create mode 100644 bookstack/rootfs/etc/services.d/php-fpm/finish create mode 100644 bookstack/rootfs/etc/services.d/php-fpm/run create mode 100644 bookstack/rootfs/var/www/bookstack/.env create mode 100644 renovate.json diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..7a12570 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,19 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true +ident_size = 4 + +[*.md] +ident_size = 2 +trim_trailing_whitespace = false + +[*.json] +ident_size = 2 + +[{.gitignore,.gitkeep,.editorconfig}] +ident_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..fa967b9 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +* text=auto eol=lf +*. eol=lf +*.sh eol=lf \ No newline at end of file diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..3fbad49 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# Require maintainer's :+1: for changes to the .github/ repo-config files +# mainly due to https://github.com/probot/settings privilege escalation +.github/* @frenck +.gitlab-ci.yml @frenck diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..544da8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,20 @@ +# Problem/Motivation + +> (Why the issue was filed) + +## Expected behavior + +> (What you expected to happen) + +## Actual behavior + +> (What actually happened) + +## Steps to reproduce + +> (How can someone else make/see it happen) + +## Proposed changes + +> (If you have a proposed change, workaround or fix, +> describe the rationale behind it) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..cbd529a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +# Proposed Changes + +> (Describe the changes and rationale behind them) + +## Related Issues + +> ([Github link][autolink-references] to related issues or pull requests) + +[autolink-references]: https://help.github.com/articles/autolinked-references-and-urls/ \ No newline at end of file diff --git a/.github/autolabeler.yml b/.github/autolabeler.yml new file mode 100644 index 0000000..3ce5703 --- /dev/null +++ b/.github/autolabeler.yml @@ -0,0 +1,2 @@ +--- +"Type: Documentation": ["*.md", "*.j2"] diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000..71d2f6d --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,50 @@ +--- +# Configuration for request-info - https://github.com/behaviorbot/request-info + +# *OPTIONAL* Comment to reply with +# Can be either a string : +requestInfoReplyComment: + - "We would appreciate it if you could provide us with more info about this issue/pr!" + - "Hmmm... That issue/PR is kinda low on text. Could you please provide some more content?" + +# *OPTIONAL* default titles to check against for lack of descriptiveness +# MUST BE ALL LOWERCASE +requestInfoDefaultTitles: [] + +# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given +requestInfoLabelToAdd: "Incomplete" + +# *OPTIONAL* Require Pull Requests to contain more information than what is provided in the PR template +# Will fail if the pull request's body is equal to the provided template +checkPullRequestTemplate: true + +# *OPTIONAL* Only warn about insufficient information on these events type +# Keys must be lowercase. Valid values are 'issue' and 'pullRequest' +requestInfoOn: + pullRequest: true + issue: true + +# *OPTIONAL* Add a list of people whose Issues/PRs will not be commented on +# keys must be GitHub usernames +requestInfoUserstoExclude: [] + +# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome + +# Comment to be posted to on first time issues +newIssueWelcomeComment: > + :wave: Thanks for opening your first issue here! + If you're reporting a :bug: bug, please make sure you include steps to reproduce it. + Also, logs, error messages and information about your hardware might be usefull. + +# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome + +# Comment to be posted to on PRs from first time contributors in your repository +newPRWelcomeComment: > + :sparkling_heart: Thanks for opening this pull request! :sparkling_heart: + If your PR gets accepted and merged in, we will invite you to the project :tada: + +# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge + +# Comment to be posted to on pull requests merged by a first time user +firstPRMergeComment: > + Congrats on merging your first pull request! :tada::tada::tada: diff --git a/.github/invite-contributors.yml b/.github/invite-contributors.yml new file mode 100644 index 0000000..25eb31a --- /dev/null +++ b/.github/invite-contributors.yml @@ -0,0 +1,10 @@ +--- +# If true, this will add new contributors as outside collaborators +# to the repo their PR was merged in. Team name is ignored if this +# flag is set to true. +isOutside: false + +# Specify team name to add new contributors to a specific team +# within your organization. +# Use team name or team-name-slug +team: Contributors diff --git a/.github/lock.yml b/.github/lock.yml new file mode 100644 index 0000000..4b1e816 --- /dev/null +++ b/.github/lock.yml @@ -0,0 +1,20 @@ +--- +# Configuration for lock-threads - https://github.com/dessant/lock-threads +# Number of days of inactivity before a closed issue or pull request is locked +daysUntilLock: 30 + +# Comment to post before locking. Set to `false` to disable +lockComment: > + This thread has been automatically locked because it has not had recent + activity. Please open a new issue for related bugs and link to relevant + comments in this thread. + +# Issues or pull requests with these labels will not be locked +# exemptLabels: +# - no-locking + +# Limit to only `issues` or `pulls` +# only: issues + +# Add a label when locking. Set to `false` to disable +lockLabel: false diff --git a/.github/move.yml b/.github/move.yml new file mode 100644 index 0000000..0c2276a --- /dev/null +++ b/.github/move.yml @@ -0,0 +1,20 @@ +--- +# Delete the command comment when it contains no other content +deleteCommand: true + +# Close the source issue after moving +closeSourceIssue: true + +# Lock the source issue after moving +lockSourceIssue: true + +# Mention issue and comment authors +mentionAuthors: true + +# Preserve mentions in the issue content +keepContentMentions: false + +# Set custom aliases for targets +# aliases: +# r: repo +# or: owner/repo diff --git a/.github/no-response.yml b/.github/no-response.yml new file mode 100644 index 0000000..bb9f0f2 --- /dev/null +++ b/.github/no-response.yml @@ -0,0 +1,13 @@ +--- +# Configuration for probot-no-response - https://github.com/probot/no-response +# Number of days of inactivity before an Issue is closed for lack of response +daysUntilClose: 14 +# Label requiring a response +responseRequiredLabel: "Status: Awaiting response" +# Comment to post when closing an Issue for lack of response. Set to `false` to disable +closeComment: > + This issue has been automatically closed because there has been no response + to our request for more information from the original author. With only the + information that is currently in the issue, we don't have enough information + to take action. Please reach out if you have or find the answers we need so + that we can investigate further. diff --git a/.github/potential-duplicates.yml b/.github/potential-duplicates.yml new file mode 100644 index 0000000..00c7c0f --- /dev/null +++ b/.github/potential-duplicates.yml @@ -0,0 +1,14 @@ +--- +# Label name and color to set, when potential duplicates are detected +issueLabel: "Potential duplicate" +labelColor: e6e6e6 + +# If similarity is higher than this threshold, issue will be marked as duplicate +threshold: 0.70 + +# Comment to post when potential duplicates are detected +referenceComment: > + Potential duplicates found: + {{#issues}} + - [#{{ number }}] {{ title }} ({{ accuracy }}%) + {{/issues}} diff --git a/.github/settings.yml b/.github/settings.yml new file mode 100644 index 0000000..9acc565 --- /dev/null +++ b/.github/settings.yml @@ -0,0 +1,150 @@ +--- +repository: + description: "chrony - Community Hass.io Add-on for Home Assistant" + homepage: https://addons.community + topics: ntp, chrony, hassio-addons, hassio, hass, home-assistant, homeassistant + private: false + has_issues: true + has_projects: false + has_wiki: false + has_downloads: false + default_branch: master + allow_squash_merge: true + allow_merge_commit: false + allow_rebase_merge: true +labels: + # Priority labels + - name: "Priority: Critical" + color: ee0701 + description: "This should be dealt with ASAP. Not fixing this issue would be a serious error." + - name: "Priority: High" + color: b60205 + description: "After critical issues are fixed, these should be dealt with before any further issues." + - name: "Priority: Medium" + color: 0e8a16 + description: "This issue may be useful, and needs some attention." + - name: "Priority: Low" + color: e4ea8a + description: "Nice addition, maybe... someday..." + + # Type labels + - name: "Type: Bug" + color: ee0701 + description: "Inconsistencies or issues which will cause a problem for users or implementors." + - name: "Type: Documentation" + color: 0052cc + description: "Solely about the documentation of the project." + - name: "Type: Enhancement" + color: 1d76db + description: "Enhancement of the code, not introducing new features." + - name: "Type: Feature" + color: 0e8a16 + description: "New features or options." + - name: "Type: Support" + color: 5319e7 + description: "Marks an issue as an support ticket." + - name: "Type: Discussion" + color: d4c5f9 + description: "Marks an issue as an generic discussion ticket." + - name: "Type: Maintaince" + color: 2af79e + description: "Generic maintaince tasks, e.g., package updates." + + # Additional markers + - name: "Security" + color: ee0701 + description: "Marks an security issues that needs to be resolved asap." + - name: "Idea" + color: fef2c0 + description: "Marks an idea, which might be excepted and implemented." + - name: "Incomplete" + color: fef2c0 + description: "Marks an PR or issue that is missing information." + - name: "Pull request" + color: fbca04 + description: "There is an PR opened for this issue." + - name: "Accepted" + color: c2e0c6 + description: "This issue or PR has been accepted." + - name: "Declined" + color: f9d0c4 + description: "This issue or PR has been declined." + - name: "Potential duplicate" + color: e6e6e6 + description: "This issue has been automatically marked as a potential duplicate." + + # Ongoing Status labels + - name: "Status: Triage" + color: fbca04 + description: "This issue needs to be triaged." + - name: "Status: On hold" + color: cccccc + description: "Issue or PR that has been placed on hold for now." + - name: "Status: In progress" + color: fbca04 + description: "Issue is currently being resolved by a developer." + - name: "Status: Stale" + color: fef2c0 + description: "There has not been activity on this issue or PR for quite some time." + - name: "Status: Awaiting response" + color: fef2c0 + description: "Issue or PR awaits response from the creator." + - name: "Status: Blocked" + color: fef2c0 + description: "Progress on this issue is currently not possible." + + # Closing status labels + - name: "Closed: Known limitation" + color: e6e6e6 + description: "Issue is closed, it is a known limitation." + - name: "Closed: Expected behavior" + color: e6e6e6 + description: "Issues is closed, it is expected behavior." + - name: "Closed: Duplicate" + color: e6e6e6 + description: "Issue is closed, duplicate of an existing issue." + - name: "Closed: Invalid" + color: e6e6e6 + description: "Issue is closed, marked as not a valid issue (e.g., an user error)." + - name: "Closed: Wrong repository" + color: e6e6e6 + description: "Issue is closed, was created in the wrong repository." + - name: "Closed: Won't Fix" + color: e6e6e6 + description: "Issue is closed, it won't be fixed." + - name: "Closed: Done" + color: c2e0c6 + description: "Issue closed, work on this issue has been marked complete." + + # Others + - name: "Beginner Friendly" + color: 0e8a16 + description: "Good first issue for people wanting to contribute to the project." + - name: "Help wanted" + color: 0e8a16 + description: "We need some extra helping hands or expertise in order to resolve this." + - name: "Hacktoberfest" + description: "Issues/PRs are participating in the Hacktoberfest" + color: fbca04 + +branches: + - name: master + protection: + required_pull_request_reviews: + # required_approving_review_count: 1 + dismiss_stale_reviews: true + require_code_owner_reviews: true + dismissal_restrictions: + users: [] + teams: + - Admins + - Masters + required_status_checks: + strict: false + contexts: [] + enforce_admins: false + restrictions: + users: [] + teams: + - Admins + - Masters diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 0000000..36938bb --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,61 @@ +--- +# Configuration for probot-stale - https://github.com/probot/stale + +# Number of days of inactivity before an Issue or Pull Request becomes stale +daysUntilStale: 60 + +# Number of days of inactivity before a stale Issue or Pull Request is closed. +# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale. +daysUntilClose: 7 + +# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable +exemptLabels: + - "Status: On hold" + - "Status: In progress" + - "Status: Awaiting response" + - "Status: Blocked" + - "Idea" + - "Security" + +# Set to true to ignore issues in a project (defaults to false) +exemptProjects: false + +# Set to true to ignore issues in a milestone (defaults to false) +exemptMilestones: false + +# Label to use when marking as stale +staleLabel: "Status: Stale" + +# Comment to post when marking as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. + +# Comment to post when removing the stale label. +# unmarkComment: > +# Your comment here. +unmarkComment: false + +# Comment to post when closing a stale Issue or Pull Request. +# closeComment: > +# Your comment here. +closeComment: false + +# Limit the number of actions per hour, from 1-30. Default is 30 +limitPerRun: 30 + +# Limit to only `issues` or `pulls` +only: issues + +# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls': +# pulls: +# daysUntilStale: 30 +# markComment: > +# This pull request has been automatically marked as stale because it has not had +# recent activity. It will be closed if no further activity occurs. Thank you +# for your contributions. + +# issues: +# exemptLabels: +# - confirmed diff --git a/.github/support.yml b/.github/support.yml new file mode 100644 index 0000000..27e688f --- /dev/null +++ b/.github/support.yml @@ -0,0 +1,22 @@ +--- +# Configuration for support-requests - https://github.com/dessant/support-requests + +# Label used to mark issues as support requests +supportLabel: "Type: Support" + +# Comment to post on issues marked as support requests. Add a link +# to a support page, or set to `false` to disable +supportComment: > + :wave: We use the issue tracker exclusively for bug reports and feature requests. + However, this issue appears to be a support request. Please use our + support channels to get help with the project. + + Head over to the + [Home Assistant community forum](https://community.home-assistant.io/?u=frenck) + or join our [Discord](https://discord.me/hassioaddons) chat. + +# Close issues marked as support requests +close: true + +# Lock issues marked as support requests +lock: false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..c36d620 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,14 @@ +--- +include: https://raw.githubusercontent.com/hassio-addons/organization/master/gitlabci/addon.yml + +variables: + ADDON_GITHUB_REPO: "hassio-addons/addon-bookstack" + ADDON_SLUG: "bookstack" + ADDON_TARGET: "bookstack" + ADDON_LEGACY_TAGS: "true" + + ADDON_AARCH64_BASE: "hassioaddons/base-aarch64:3.1.0" + ADDON_AMD64_BASE: "hassioaddons/base-amd64:3.1.0" + ADDON_ARMHF_BASE: "hassioaddons/base-armhf:3.1.0" + ADDON_ARMV7_BASE: "hassioaddons/base-armv7:3.1.0" + ADDON_I386_BASE: "hassioaddons/base-i386:3.1.0" diff --git a/.mdlrc b/.mdlrc new file mode 100644 index 0000000..2b0128d --- /dev/null +++ b/.mdlrc @@ -0,0 +1 @@ +rules "~MD024" \ No newline at end of file diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..f4bc5a4 --- /dev/null +++ b/.yamllint @@ -0,0 +1,66 @@ +--- +rules: + braces: + level: error + min-spaces-inside: 0 + max-spaces-inside: 1 + min-spaces-inside-empty: -1 + max-spaces-inside-empty: -1 + brackets: + level: error + min-spaces-inside: 0 + max-spaces-inside: 0 + min-spaces-inside-empty: -1 + max-spaces-inside-empty: -1 + colons: + level: error + max-spaces-before: 0 + max-spaces-after: 1 + commas: + level: error + max-spaces-before: 0 + min-spaces-after: 1 + max-spaces-after: 1 + comments: + level: error + require-starting-space: true + min-spaces-from-content: 2 + comments-indentation: + level: error + document-end: + level: error + present: false + document-start: + level: error + present: true + empty-lines: + level: error + max: 1 + max-start: 0 + max-end: 1 + hyphens: + level: error + max-spaces-after: 1 + indentation: + level: error + spaces: 2 + indent-sequences: true + check-multi-line-strings: false + key-duplicates: + level: error + line-length: + ignore: | + .github/support.yml + level: warning + max: 120 + allow-non-breakable-words: true + allow-non-breakable-inline-mappings: true + new-line-at-end-of-file: + level: error + new-lines: + level: error + type: unix + trailing-spaces: + level: error + truthy: + level: error diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0ac232b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Code of conduct + +## Our pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention + or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or + electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate + in a professional setting + +## Our responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project lead at frenck@addons.community. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project lead is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f2d2e98 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish +to make via issue, email, or any other method with the owners of this repository +before making a change. + +Please note we have a code of conduct, please follow it in all your interactions +with the project. + +## Issues and feature requests + +You've found a bug in the source code, a mistake in the documentation or maybe +you'd like a new feature? You can help us by submitting an issue to our +[GitHub Repository][github]. Before you create an issue, make sure you search +the archive, maybe your question was already answered. + +Even better: You could submit a pull request with a fix / new feature! + +## Pull request process + +1. Search our repository for open or closed [pull requests][prs] that relates + to your submission. You don't want to duplicate effort. + +1. You may merge the pull request in once you have the sign-off of two other + developers, or if you do not have permission to do that, you may request + the second reviewer to merge it for you. + +[github]: https://github.com/hassio-addons/addon-bookstack/issues +[prs]: https://github.com/hassio-addons/addon-bookstack/pulls diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..3ff7c1f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2019 Paul Sinclair + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0f86777 --- /dev/null +++ b/README.md @@ -0,0 +1,186 @@ +# Community Hass.io Add-ons: Bookstack + +[![GitHub Release][releases-shield]][releases] +![Project Stage][project-stage-shield] +[![License][license-shield]](LICENSE.md) + +![Supports aarch64 Architecture][aarch64-shield] +![Supports amd64 Architecture][amd64-shield] +![Supports armhf Architecture][armhf-shield] +![Supports armv7 Architecture][armv7-shield] +![Supports i386 Architecture][i386-shield] + +[![GitLab CI][gitlabci-shield]][gitlabci] +![Project Maintenance][maintenance-shield] +[![GitHub Activity][commits-shield]][commits] + +[![Discord][discord-shield]][discord] +[![Community Forum][forum-shield]][forum] + +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] + +Bookstack. + +## About + +BookStack is a simple, self-hosted, easy-to-use platform for organising and +storing information. Please support the developers of this software at + [[Bookstack](https://www.bookstackapp.com/)]. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Hass.io add-on. + +1. [Add our Hass.io add-ons repository][repository] to your Hass.io instance. +1. Install the "bookstack" add-on. +1. Start the "bookstack" add-on +1. Check the logs of the "bookstack" add-on to see if everything went well. +1. Default login information is admin@admin.com/password. + +**NOTE**: Do not add this repository to Hass.io, please use: +`https://github.com/hassio-addons/repository`. + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```json +{ +} +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +## Known issues and limitations + +SMTP support is disabled. + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Community Hass.io Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Contributing + +This is an active open-source project. We are always open to people who want to +use the code or contribute to it. + +We have set up a separate document containing our +[contribution guidelines](CONTRIBUTING.md). + +Thank you for being involved! :heart_eyes: + +## Authors & contributors + +The original setup of this repository is by [Paul Sinclair][sinclairpaul]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## We have got some Hass.io add-ons for you + +Want some more functionality to your Hass.io Home Assistant instance? + +We have created multiple add-ons for Hass.io. For a full list, check out +our [GitHub Repository][repository]. + +## License + +MIT License + +Copyright (c) 2019 Paul Sinclair + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[alpine-packages]: https://pkgs.alpinelinux.org/packages +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/sinclairpaul +[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-chrony.svg +[commits]: https://github.com/hassio-addons/addon-chrony/commits/master +[contributors]: https://github.com/hassio-addons/addon-chrony/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/t/community-hass-io-xxxxx/xxxxx +[sinclairpaul]: https://github.com/sinclairpaul +[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-chrony/badges/master/pipeline.svg +[gitlabci]: https://gitlab.com/hassio-addons/addon-chrony/pipelines +[home-assistant]: https://home-assistant.io +[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[issue]: https://github.com/hassio-addons/addon-chrony/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-chrony.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg +[npm-packages]: https://www.npmjs.com +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[reddit]: https://reddit.com/r/homeassistant +[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-chrony.svg +[releases]: https://github.com/hassio-addons/addon-chrony/releases +[repository]: https://github.com/hassio-addons/repository +[semver]: http://semver.org/spec/v2.0.0.htm \ No newline at end of file diff --git a/bookstack/.README.j2 b/bookstack/.README.j2 new file mode 100644 index 0000000..901847b --- /dev/null +++ b/bookstack/.README.j2 @@ -0,0 +1,66 @@ +# Community Hass.io Add-ons: chrony + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] + +Bookstack. + +## About + +TBD. + +[Click here for the full documentation][docs] + +{% if channel == "edge" %} +## WARNING! THIS IS AN EDGE VERSION! + +This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds +add-ons are based upon the latest development version. + +- They may not work at all. +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. +- Developers. + +If you are more interested in stable releases of our add-ons: + + + +{% endif %} +{% if channel == "beta" %} +## WARNING! THIS IS A BETA VERSION! + +This Hass.io Add-ons repository contains beta releases of add-ons. + +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. + +If you are more interested in stable releases of our add-ons: + + + +{% endif %} +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/sinclairpaul +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[docs]: {{ repo }}/blob/{{ version }}/README.md +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/?u=frenck +[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg +[release]: {{ repo }}/tree/{{ version }} diff --git a/bookstack/Dockerfile b/bookstack/Dockerfile new file mode 100644 index 0000000..1d7059d --- /dev/null +++ b/bookstack/Dockerfile @@ -0,0 +1,76 @@ +ARG BUILD_FROM=hassioaddons/base:3.1.0 +# hadolint ignore=DL3006 +FROM ${BUILD_FROM} + +# Set shell +SHELL ["/bin/bash", "-o", "pipefail", "-c"] + +# Setup base +# hadolint ignore=DL3003 +RUN \ + apk add --no-cache \ + lua-resty-http=0.12-r1 \ + mariadb=10.3.13-r0 \ + mariadb-client=10.3.13-r0 \ + nginx=1.14.2-r0 \ + nginx-mod-http-lua=1.14.2-r0 \ + php7-curl=7.2.14-r0 \ + php7-dom=7.2.14-r0 \ + php7-fileinfo=7.2.14-r0 \ + php7-fpm=7.2.14-r0 \ + php7-gd=7.2.14-r0 \ + php7-json=7.2.14-r0 \ + php7-mbstring=7.2.14-r0 \ + php7-mysqlnd=7.2.14-r0 \ + php7-openssl=7.2.14-r0 \ + php7-pdo_mysql=7.2.14-r0 \ + php7-session=7.2.14-r0 \ + php7-simplexml=7.2.14-r0 \ + php7-tidy=7.2.14-r0 \ + php7-tokenizer=7.2.14-r0 \ + php7-xml=7.2.14-r0 \ + php7=7.2.14-r0 \ + \ + && apk add --no-cache --virtual .build-dependencies \ + composer=1.8.0-r1 \ + \ + && curl -J -L -o /tmp/bookstack.tar.gz \ + https://github.com/BookStackApp/BookStack/archive/v0.25.5.tar.gz \ + && mkdir -p /var/www/bookstack \ + && tar zxvf /tmp/bookstack.tar.gz -C \ + /var/www/bookstack --strip-components=1 \ + && cd /var/www/bookstack \ + \ + && composer install --no-dev \ + && apk del --purge .build-dependencies \ + \ + && find /var/www/bookstack -type f -name "*.md" -depth -exec rm -f {} \; \ + && rm -f -r \ + /tmp/* + +# Copy root filesystem +COPY rootfs / + +# Build arguments +ARG BUILD_ARCH +ARG BUILD_DATE +ARG BUILD_REF +ARG BUILD_VERSION + +# Labels +LABEL \ + io.hass.name="Bookstack" \ + io.hass.description="xxxx" \ + io.hass.arch="${BUILD_ARCH}" \ + io.hass.type="addon" \ + io.hass.version=${BUILD_VERSION} \ + maintainer="Paul Sinclair " \ + org.label-schema.description="xxx" \ + org.label-schema.build-date=${BUILD_DATE} \ + org.label-schema.name="Bookstack" \ + org.label-schema.schema-version="1.0" \ + org.label-schema.url="https://community.home-assistant.io/?u=frenck" \ + org.label-schema.usage="https://github.com/hassio-addons/addon-bookstack/tree/master/README.md" \ + org.label-schema.vcs-ref=${BUILD_REF} \ + org.label-schema.vcs-url="https://github.com/hassio-addons/addon-bookstack" \ + org.label-schema.vendor="Community Hass.io Addons" diff --git a/bookstack/build.json b/bookstack/build.json new file mode 100644 index 0000000..6796f2b --- /dev/null +++ b/bookstack/build.json @@ -0,0 +1,11 @@ +{ + "squash": false, + "build_from": { + "aarch64": "hassioaddons/base-aarch64:3.1.0", + "amd64": "hassioaddons/base-amd64:3.1.0", + "armhf": "hassioaddons/base-armhf:3.1.0", + "armv7": "hassioaddons/base-armv7:3.1.0", + "i386": "hassioaddons/base-i386:3.1.0" + }, + "args": {} +} \ No newline at end of file diff --git a/bookstack/config.json b/bookstack/config.json new file mode 100644 index 0000000..408690e --- /dev/null +++ b/bookstack/config.json @@ -0,0 +1,38 @@ +{ + "name": "Bookstack", + "version": "dev", + "slug": "bookstack", + "description": "A platform for organising and storing information", + "url": "https://github.com/hassio-addons/addon-bookstack", + "webui": "[PROTO:ssl]://[HOST]:[PORT:8181]", + "startup": "application", + "arch": [ + "aarch64", + "amd64", + "armhf", + "armv7", + "i386" + ], + "boot": "auto", + "hassio_api": true, + "hassio_role": "default", + "ingress": false, + "ingress_port": 0, + "map": [ + "ssl" + ], + "ports": { + "80/tcp": 8181 + }, + "options": { + "ssl": true, + "certfile": "fullchain.pem", + "keyfile": "privkey.pem" + }, + "schema": { + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)?", + "certfile": "str", + "keyfile": "str", + "ssl": "bool" + } +} diff --git a/bookstack/rootfs/etc/cont-init.d/20-folders.sh b/bookstack/rootfs/etc/cont-init.d/20-folders.sh new file mode 100644 index 0000000..479c586 --- /dev/null +++ b/bookstack/rootfs/etc/cont-init.d/20-folders.sh @@ -0,0 +1,29 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Community Hass.io Add-ons: Bookstack +# This file configures required folders +# ============================================================================== + +if ! bashio::fs.directory_exists "/data/mysql"; then + bashio::log "Creating MySql directory" + mkdir /data/mysql + chown mysql:mysql /data/mysql +fi +if ! bashio::fs.directory_exists "/data/bookstack/uploads"; then + bashio::log "Creating uploads directory" + mkdir -p /data/bookstack/uploads +fi +if ! bashio::fs.directory_exists "/data/bookstack/files"; then + bashio::log "Creating files directory" + mkdir -p /data/bookstack/files +fi +if ! bashio::fs.directory_exists "/data/bookstack/images"; then + bashio::log "Creating images directory" + mkdir -p /data/bookstack/images +fi +rm -r /var/www/bookstack/storage/uploads/files +rm -r /var/www/bookstack/storage/uploads/images +rm -r /var/www/bookstack/public/uploads +ln -s /data/bookstack/files /var/www/bookstack/storage/uploads/files +ln -s /data/bookstack/images /var/www/bookstack/storage/uploads/images +ln -s /data/bookstack/uploads /var/www/bookstack/public/uploads diff --git a/bookstack/rootfs/etc/cont-init.d/30-nginx.sh b/bookstack/rootfs/etc/cont-init.d/30-nginx.sh new file mode 100644 index 0000000..eb86c50 --- /dev/null +++ b/bookstack/rootfs/etc/cont-init.d/30-nginx.sh @@ -0,0 +1,34 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Community Hass.io Add-ons: Bookstack +# This file configures nginx +# ============================================================================== +declare admin_port +declare certfile +#declare ingress_interface +#declare ingress_port +declare keyfile + +admin_port=$(bashio::addon.port 80) +if bashio::var.has_value "${admin_port}"; then + bashio::config.require.ssl + + if bashio::config.true 'ssl'; then + certfile=$(bashio::config 'certfile') + keyfile=$(bashio::config 'keyfile') + + mv /etc/nginx/servers/direct-ssl.disabled /etc/nginx/servers/direct.conf + sed -i "s/%%certfile%%/${certfile}/g" /etc/nginx/servers/direct.conf + sed -i "s/%%keyfile%%/${keyfile}/g" /etc/nginx/servers/direct.conf + + else + mv /etc/nginx/servers/direct.disabled /etc/nginx/servers/direct.conf + fi + + sed -i "s/%%port%%/80/g" /etc/nginx/servers/direct.conf +fi + +#ingress_port=$(bashio::addon.ingress_port) +#ingress_interface=$(bashio::addon.ip_address) +#sed -i "s/%%port%%/${ingress_port}/g" /etc/nginx/servers/ingress.conf +#sed -i "s/%%interface%%/${ingress_interface}/g" /etc/nginx/servers/ingress.conf \ No newline at end of file diff --git a/bookstack/rootfs/etc/cont-init.d/31-mysql.sh b/bookstack/rootfs/etc/cont-init.d/31-mysql.sh new file mode 100644 index 0000000..3909d1d --- /dev/null +++ b/bookstack/rootfs/etc/cont-init.d/31-mysql.sh @@ -0,0 +1,46 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Community Hass.io Add-ons: Bookstack +# This file initialises the MySQL database +# ============================================================================== + +# Initialize the database data directory. +if ! bashio::fs.directory_exists "/data/mysql/mysql"; then + + bashio::log.info "Initializing database..." + s6-setuidgid mysql mysql_install_db --datadir=/data/mysql \ + # Start MySQL. + /usr/bin/mysqld_safe --datadir=/data/mysql \ + --tmpdir=/tmp/ --user=mysql & + rc="$?" + pid="$!" + if [ "$rc" -ne 0 ]; then + bashio::exit.nok "Failed to start the database." + fi + + # Wait until it is ready. + for _ in $(seq 1 30); do + if echo 'SELECT 1' | mysql &> /dev/null; then + break + fi + sleep 1 + done + + # Secure the installation. + printf '\nn\n\n\n\n\n' | /usr/bin/mysql_secure_installation + + # Create the database. + bashio::log.info "Creating Database..." + echo "CREATE DATABASE IF NOT EXISTS \`bookstack\` ;" | mysql + + # Create the user. + bashio::log.info "Creating User..." + echo "CREATE USER 'bookstack'@'localhost' IDENTIFIED BY 'bookstack' ;" | mysql + echo "GRANT ALL ON \`bookstack\`.* TO 'bookstack'@'localhost' ;" | mysql + + # Stop the MySQL server + childpid=$(pgrep -P "$pid") + if ! kill -s TERM "$childpid" || ! wait "$pid"; then + bashio::exit.nok "Initialization of database failed." + fi +fi \ No newline at end of file diff --git a/bookstack/rootfs/etc/cont-init.d/32-bookstack.sh b/bookstack/rootfs/etc/cont-init.d/32-bookstack.sh new file mode 100644 index 0000000..fc3c5ed --- /dev/null +++ b/bookstack/rootfs/etc/cont-init.d/32-bookstack.sh @@ -0,0 +1,18 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Community Hass.io Add-ons: Bookstack +# This file creates/upgrades the MYSQL db and configures the app key +# ============================================================================== +declare key +# Create API key if needed +if ! bashio::fs.file_exists "/data/bookstack/appkey.txt"; then + bashio::log.info "Generating app key" + key=$(php /var/www/bookstack/artisan key:generate --show) + echo "${key}" > /data/bookstack/appkey.txt + bashio::log.info "App Key generated: ${key}" +else + key=$(cat /data/bookstack/appkey.txt) +fi +sed -i "s,APP_KEY=SomeRandomString,APP_KEY=${key},g" \ + /var/www/bookstack/.env + diff --git a/bookstack/rootfs/etc/fix-attrs.d/31-mysql b/bookstack/rootfs/etc/fix-attrs.d/31-mysql new file mode 100644 index 0000000..6164741 --- /dev/null +++ b/bookstack/rootfs/etc/fix-attrs.d/31-mysql @@ -0,0 +1,3 @@ +/data/mysql true mysql 0644 0755 +/run/mysqld true mysql 0644 0755 +/etc/my.cnf true mysql 0444 0755 \ No newline at end of file diff --git a/bookstack/rootfs/etc/fix-attrs.d/33-bookstack b/bookstack/rootfs/etc/fix-attrs.d/33-bookstack new file mode 100644 index 0000000..efb1900 --- /dev/null +++ b/bookstack/rootfs/etc/fix-attrs.d/33-bookstack @@ -0,0 +1,3 @@ +/var/www/bookstack/storage/framework/views false nginx 0644 0755 +/var/www/bookstack/storage/framework/cache false nginx 0644 0755 +/var/www/bookstack/storage/framework/sessions false nginx 0644 0755 \ No newline at end of file diff --git a/bookstack/rootfs/etc/nginx/includes/mime.types b/bookstack/rootfs/etc/nginx/includes/mime.types new file mode 100644 index 0000000..7c7cdef --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/mime.types @@ -0,0 +1,96 @@ +types { + text/html html htm shtml; + text/css css; + text/xml xml; + image/gif gif; + image/jpeg jpeg jpg; + application/javascript js; + application/atom+xml atom; + application/rss+xml rss; + + text/mathml mml; + text/plain txt; + text/vnd.sun.j2me.app-descriptor jad; + text/vnd.wap.wml wml; + text/x-component htc; + + image/png png; + image/svg+xml svg svgz; + image/tiff tif tiff; + image/vnd.wap.wbmp wbmp; + image/webp webp; + image/x-icon ico; + image/x-jng jng; + image/x-ms-bmp bmp; + + font/woff woff; + font/woff2 woff2; + + application/java-archive jar war ear; + application/json json; + application/mac-binhex40 hqx; + application/msword doc; + application/pdf pdf; + application/postscript ps eps ai; + application/rtf rtf; + application/vnd.apple.mpegurl m3u8; + application/vnd.google-earth.kml+xml kml; + application/vnd.google-earth.kmz kmz; + application/vnd.ms-excel xls; + application/vnd.ms-fontobject eot; + application/vnd.ms-powerpoint ppt; + application/vnd.oasis.opendocument.graphics odg; + application/vnd.oasis.opendocument.presentation odp; + application/vnd.oasis.opendocument.spreadsheet ods; + application/vnd.oasis.opendocument.text odt; + application/vnd.openxmlformats-officedocument.presentationml.presentation + pptx; + application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + xlsx; + application/vnd.openxmlformats-officedocument.wordprocessingml.document + docx; + application/vnd.wap.wmlc wmlc; + application/x-7z-compressed 7z; + application/x-cocoa cco; + application/x-java-archive-diff jardiff; + application/x-java-jnlp-file jnlp; + application/x-makeself run; + application/x-perl pl pm; + application/x-pilot prc pdb; + application/x-rar-compressed rar; + application/x-redhat-package-manager rpm; + application/x-sea sea; + application/x-shockwave-flash swf; + application/x-stuffit sit; + application/x-tcl tcl tk; + application/x-x509-ca-cert der pem crt; + application/x-xpinstall xpi; + application/xhtml+xml xhtml; + application/xspf+xml xspf; + application/zip zip; + + application/octet-stream bin exe dll; + application/octet-stream deb; + application/octet-stream dmg; + application/octet-stream iso img; + application/octet-stream msi msp msm; + + audio/midi mid midi kar; + audio/mpeg mp3; + audio/ogg ogg; + audio/x-m4a m4a; + audio/x-realaudio ra; + + video/3gpp 3gpp 3gp; + video/mp2t ts; + video/mp4 mp4; + video/mpeg mpeg mpg; + video/quicktime mov; + video/webm webm; + video/x-flv flv; + video/x-m4v m4v; + video/x-mng mng; + video/x-ms-asf asx asf; + video/x-ms-wmv wmv; + video/x-msvideo avi; +} diff --git a/bookstack/rootfs/etc/nginx/includes/php.conf b/bookstack/rootfs/etc/nginx/includes/php.conf new file mode 100644 index 0000000..a881b0f --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/php.conf @@ -0,0 +1,5 @@ +location ~ \.php$ { + fastcgi_pass 127.0.0.1:9001; + fastcgi_index index.php; + include fastcgi.conf; +} \ No newline at end of file diff --git a/bookstack/rootfs/etc/nginx/includes/proxy_params.conf b/bookstack/rootfs/etc/nginx/includes/proxy_params.conf new file mode 100644 index 0000000..aa69123 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/proxy_params.conf @@ -0,0 +1,15 @@ +proxy_http_version 1.1; +proxy_ignore_client_abort off; +proxy_read_timeout 86400s; +#proxy_redirect off; +proxy_send_timeout 86400s; +proxy_max_temp_file_size 0; + +proxy_set_header Accept-Encoding ""; +proxy_set_header Connection $connection_upgrade; +proxy_set_header Host $http_host; +proxy_set_header Upgrade $http_upgrade; +proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; +proxy_set_header X-Forwarded-Proto $scheme; +proxy_set_header X-NginX-Proxy true; +proxy_set_header X-Real-IP $remote_addr; diff --git a/bookstack/rootfs/etc/nginx/includes/resolver.conf b/bookstack/rootfs/etc/nginx/includes/resolver.conf new file mode 100644 index 0000000..758ca69 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/resolver.conf @@ -0,0 +1 @@ +resolver 172.30.32.2; diff --git a/bookstack/rootfs/etc/nginx/includes/server_params.conf b/bookstack/rootfs/etc/nginx/includes/server_params.conf new file mode 100644 index 0000000..09c0654 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/server_params.conf @@ -0,0 +1,6 @@ +root /dev/null; +server_name $hostname; + +add_header X-Content-Type-Options nosniff; +add_header X-XSS-Protection "1; mode=block"; +add_header X-Robots-Tag none; diff --git a/bookstack/rootfs/etc/nginx/includes/server_params_local.conf b/bookstack/rootfs/etc/nginx/includes/server_params_local.conf new file mode 100644 index 0000000..f702d86 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/server_params_local.conf @@ -0,0 +1,3 @@ +root /var/www/bookstack/public; +index index.php; +server_name $hostname; diff --git a/bookstack/rootfs/etc/nginx/includes/ssl_params.conf b/bookstack/rootfs/etc/nginx/includes/ssl_params.conf new file mode 100644 index 0000000..6f15005 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/ssl_params.conf @@ -0,0 +1,9 @@ +ssl_protocols TLSv1.2; +ssl_prefer_server_ciphers on; +ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:DHE-RSA-AES256-SHA; +ssl_ecdh_curve secp384r1; +ssl_session_timeout 10m; +ssl_session_cache shared:SSL:10m; +ssl_session_tickets off; +ssl_stapling on; +ssl_stapling_verify on; diff --git a/bookstack/rootfs/etc/nginx/includes/upstream.conf b/bookstack/rootfs/etc/nginx/includes/upstream.conf new file mode 100644 index 0000000..6dc04d8 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/includes/upstream.conf @@ -0,0 +1,3 @@ +upstream backend { + server 127.0.0.1:80; +} diff --git a/bookstack/rootfs/etc/nginx/lua/ha-auth.lua b/bookstack/rootfs/etc/nginx/lua/ha-auth.lua new file mode 100644 index 0000000..4c9ca91 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/lua/ha-auth.lua @@ -0,0 +1,83 @@ +local http = require "resty.http" +local auths = ngx.shared.auths + +function authenticate() + + --- Test Authentication header is set and with a value + local header = ngx.req.get_headers()['Authorization'] + if header == nil or header:find(" ") == nil then + return false + end + + local divider = header:find(' ') + if header:sub(0, divider-1) ~= 'Basic' then + return false + end + + local auth = ngx.decode_base64(header:sub(divider+1)) + if auth == nil or auth:find(':') == nil then + return false + end + + divider = auth:find(':') + local username = auth:sub(0, divider-1) + local password = auth:sub(divider+1) + + --- Check if authentication is cached + if auths:get(username) == password then + ngx.log(ngx.DEBUG, "Authenticated user against Home Assistant (cache).") + return true + end + + --- HTTP request against Hassio API + local httpc = http.new() + local res, err = httpc:request_uri("http://hassio/auth", { + method = "POST", + body = ngx.encode_args({["username"]=username, ["password"]=password}), + headers = { + ["Content-Type"] = "application/x-www-form-urlencoded", + ["X-HASSIO-KEY"] = os.getenv("HASSIO_TOKEN"), + }, + keepalive_timeout = 60, + keepalive_pool = 10 + }) + + --- Error during API request + if err then + ngx.log(ngx.WARN, "Error during Hassio user authentication.", err) + return false + end + + --- No result? Something went wrong... + if not res then + ngx.log(ngx.WARN, "Error during Hassio user authentication.") + return false + end + + --- Valid response, the username/password is valid + if res.status == 200 then + ngx.log(ngx.INFO, "Authenticated user against Home Assistant.") + auths:set(username, password, 60) + return true + end + + --- Whatever the response is, it is invalid + ngx.log(ngx.WARN, "Authentication against Home Assistant failed!") + return false +end + +-- Only authenticate if its not disabled +if not os.getenv('DISABLE_HA_AUTHENTICATION') then + + --- Try to authenticate against HA + local authenticated = authenticate() + + --- If authentication failed, throw a basic auth + if not authenticated then + ngx.header.content_type = 'text/plain' + ngx.header.www_authenticate = 'Basic realm="Home Assistant"' + ngx.status = ngx.HTTP_UNAUTHORIZED + ngx.say('401 Access Denied') + ngx.exit(ngx.HTTP_UNAUTHORIZED) + end +end diff --git a/bookstack/rootfs/etc/nginx/modules/ndk_http.conf.old b/bookstack/rootfs/etc/nginx/modules/ndk_http.conf.old new file mode 100644 index 0000000..2663122 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/modules/ndk_http.conf.old @@ -0,0 +1 @@ +load_module "/usr/lib/nginx/modules/ndk_http_module.so"; diff --git a/bookstack/rootfs/etc/nginx/modules/ngx_http_lua.conf.old b/bookstack/rootfs/etc/nginx/modules/ngx_http_lua.conf.old new file mode 100644 index 0000000..f885ed9 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/modules/ngx_http_lua.conf.old @@ -0,0 +1 @@ +load_module "/usr/lib/nginx/modules/ngx_http_lua_module.so"; diff --git a/bookstack/rootfs/etc/nginx/nginx.conf b/bookstack/rootfs/etc/nginx/nginx.conf new file mode 100644 index 0000000..914a638 --- /dev/null +++ b/bookstack/rootfs/etc/nginx/nginx.conf @@ -0,0 +1,58 @@ +# Run nginx in foreground. +daemon off; + +# This is run inside Docker. +user root; + +# Pid storage location. +pid /var/run/nginx.pid; + +# Set number of worker processes. +worker_processes 1; + +# Enables the use of JIT for regular expressions to speed-up their processing. +pcre_jit on; + +# Write error log to Hass.io add-on log. +error_log /proc/1/fd/1 error; + +# Load allowed environment vars +env HASSIO_TOKEN; +env DISABLE_HA_AUTHENTICATION; + +# Load dynamic modules. +include /etc/nginx/modules/*.conf; + +# Max num of simultaneous connections by a worker process. +events { + worker_connections 512; +} + +http { + include /etc/nginx/includes/mime.types; + + log_format hassio '[$time_local] $status ' + '$http_x_forwarded_for($remote_addr) ' + '$request ($http_user_agent)'; + + access_log /proc/1/fd/1 hassio; + client_max_body_size 4G; + default_type application/octet-stream; + gzip on; + keepalive_timeout 65; + #lua_shared_dict auths 16k; + sendfile on; + server_tokens off; + tcp_nodelay on; + tcp_nopush on; + + map $http_upgrade $connection_upgrade { + default upgrade; + '' close; + } + + include /etc/nginx/includes/resolver.conf; + include /etc/nginx/includes/upstream.conf; + + include /etc/nginx/servers/*.conf; +} diff --git a/bookstack/rootfs/etc/nginx/servers/direct-ssl.disabled b/bookstack/rootfs/etc/nginx/servers/direct-ssl.disabled new file mode 100644 index 0000000..fbba03f --- /dev/null +++ b/bookstack/rootfs/etc/nginx/servers/direct-ssl.disabled @@ -0,0 +1,17 @@ +server { + listen %%port%% default_server ssl http2; + + include /etc/nginx/includes/server_params_local.conf; + include /etc/nginx/includes/ssl_params.conf; + include /etc/nginx/includes/proxy_params.conf; + include /etc/nginx/includes/php.conf; + + ssl on; + ssl_certificate /ssl/%%certfile%%; + ssl_certificate_key /ssl/%%keyfile%%; + + location / { + #access_by_lua_file /etc/nginx/lua/ha-auth.lua; + try_files $uri $uri/ /index.php?$query_string; + } +} diff --git a/bookstack/rootfs/etc/nginx/servers/direct.disabled b/bookstack/rootfs/etc/nginx/servers/direct.disabled new file mode 100644 index 0000000..118bfbb --- /dev/null +++ b/bookstack/rootfs/etc/nginx/servers/direct.disabled @@ -0,0 +1,12 @@ +server { + listen %%port%% default_server; + + include /etc/nginx/includes/server_params_local.conf; + include /etc/nginx/includes/proxy_params.conf; + include /etc/nginx/includes/php.conf; + + location / { + #access_by_lua_file /etc/nginx/lua/ha-auth.lua; + try_files $uri $uri/ /index.php?$query_string; + } +} diff --git a/bookstack/rootfs/etc/php7/php-fpm.d/www.conf b/bookstack/rootfs/etc/php7/php-fpm.d/www.conf new file mode 100644 index 0000000..0ef8465 --- /dev/null +++ b/bookstack/rootfs/etc/php7/php-fpm.d/www.conf @@ -0,0 +1,11 @@ +[www] +user = nginx +group = nginx +listen = 127.0.0.1:9001 +pm = dynamic +pm.max_children = 10 +pm.start_servers = 3 +pm.min_spare_servers = 2 +pm.max_spare_servers = 5 +pm.max_requests = 1024 +clear_env = no \ No newline at end of file diff --git a/bookstack/rootfs/etc/services.d/mysql/finish b/bookstack/rootfs/etc/services.d/mysql/finish new file mode 100644 index 0000000..c9eab92 --- /dev/null +++ b/bookstack/rootfs/etc/services.d/mysql/finish @@ -0,0 +1,9 @@ +#!/usr/bin/execlineb -S0 +# ============================================================================== +# Community Hass.io Add-ons: Nginx Proxy Manager +# Take down the S6 supervision tree when the MySQL server fails +# ============================================================================== +if -n { s6-test $# -ne 0 } +if -n { s6-test ${1} -eq 256 } + +s6-svscanctl -t /var/run/s6/services diff --git a/bookstack/rootfs/etc/services.d/mysql/run b/bookstack/rootfs/etc/services.d/mysql/run new file mode 100644 index 0000000..4170858 --- /dev/null +++ b/bookstack/rootfs/etc/services.d/mysql/run @@ -0,0 +1,13 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Community Hass.io Add-ons: Bookstack +# Runs the MySQL database server +# ============================================================================== + +declare -a options + +options+=(--"datadir=/data/mysql") +options+=(--"tmpdir=/tmp/") +options+=(--"user=mysql") +bashio::log.info "Starting MySQL..." +exec /usr/bin/mysqld_safe "${options[@]}" diff --git a/bookstack/rootfs/etc/services.d/nginx/finish b/bookstack/rootfs/etc/services.d/nginx/finish new file mode 100644 index 0000000..079fd0e --- /dev/null +++ b/bookstack/rootfs/etc/services.d/nginx/finish @@ -0,0 +1,9 @@ +#!/usr/bin/execlineb -S0 +# ============================================================================== +# Community Hass.io Add-ons: Grocy +# Take down the S6 supervision tree when Nginx fails +# ============================================================================== +if -n { s6-test $# -ne 0 } +if -n { s6-test ${1} -eq 256 } + +s6-svscanctl -t /var/run/s6/services diff --git a/bookstack/rootfs/etc/services.d/nginx/run b/bookstack/rootfs/etc/services.d/nginx/run new file mode 100644 index 0000000..147d519 --- /dev/null +++ b/bookstack/rootfs/etc/services.d/nginx/run @@ -0,0 +1,17 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Community Hass.io Add-ons: Bookstack +# Runs the Nginx daemon +# ============================================================================== + +# Wait for PHP-FPM to become available +bashio::net.wait_for 9001 + +bashio::log.info "Starting NGinx..." + +# Disable HA Authentication if front door is open +if bashio::config.true 'leave_front_door_open'; then + export DISABLE_HA_AUTHENTICATION=true +fi + +exec nginx diff --git a/bookstack/rootfs/etc/services.d/php-fpm/finish b/bookstack/rootfs/etc/services.d/php-fpm/finish new file mode 100644 index 0000000..91cee15 --- /dev/null +++ b/bookstack/rootfs/etc/services.d/php-fpm/finish @@ -0,0 +1,9 @@ +#!/usr/bin/execlineb -S0 +# ============================================================================== +# Community Hass.io Add-ons: Grocy +# Take down the S6 supervision tree when PHP FPM fails +# ============================================================================== +if -n { s6-test $# -ne 0 } +if -n { s6-test ${1} -eq 256 } + +s6-svscanctl -t /var/run/s6/services diff --git a/bookstack/rootfs/etc/services.d/php-fpm/run b/bookstack/rootfs/etc/services.d/php-fpm/run new file mode 100644 index 0000000..9cdf3e8 --- /dev/null +++ b/bookstack/rootfs/etc/services.d/php-fpm/run @@ -0,0 +1,20 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Community Hass.io Add-ons: Bookstack +# Runs the PHP-FPM daemon +# ============================================================================== + +# Wait for MySQL to become available +for _ in $(seq 1 30); do + if echo 'SELECT 1' | mysql &> /dev/null; then + break + fi + sleep 1 +done + +bashio::log.info "Installing/updating Database" +php /var/www/bookstack/artisan migrate --force + +bashio::log.info "Starting PHP-FPM..." + +exec php-fpm7 --nodaemonize diff --git a/bookstack/rootfs/var/www/bookstack/.env b/bookstack/rootfs/var/www/bookstack/.env new file mode 100644 index 0000000..de91265 --- /dev/null +++ b/bookstack/rootfs/var/www/bookstack/.env @@ -0,0 +1,30 @@ +# Application key +# Used for encryption where needed. +# Run `php artisan key:generate` to generate a valid key. +APP_KEY=SomeRandomString + +# Application URL +# Remove the hash below and set a URL if using BookStack behind +# a proxy, if using a third-party authentication option. +# This must be the root URL that you want to host BookStack on. +# All URL's in BookStack will be generated using this value. +#APP_URL=%%appurl%% + +# Database details +DB_HOST=localhost +DB_DATABASE=bookstack +DB_USERNAME=bookstack +DB_PASSWORD=bookstack + +# Mail system to use +# Can be 'smtp', 'mail' or 'sendmail' +MAIL_DRIVER=smtp + +# SMTP mail options +MAIL_HOST=localhost +MAIL_PORT=1025 +MAIL_USERNAME=null +MAIL_PASSWORD=null +MAIL_ENCRYPTION=null + +# A full list of options can be found in the '.env.example.complete' file. \ No newline at end of file diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..58ca74e --- /dev/null +++ b/renovate.json @@ -0,0 +1,11 @@ +{ + "extends": [ + "config:base" + ], + "commitMessageAction": "Updates", + "commitMessageTopic": "{{depName}}", + "commitMessagePrefix": ":arrow_up:", + "labels": [ + "Type: Maintenance" + ] +}