-
Notifications
You must be signed in to change notification settings - Fork 2.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add official Backdrop docs #540
Closed
+87
−0
Closed
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
a6ed0f2
First pass on source docs for backdrop
pirog 6280784
Update update.sh to include backdrop
pirog 0198c8d
Dont need the DSSTORE in the backdrop folder
pirog 4944747
The robots build the backdrop readme.
pirog a49f9b2
Added user feedback links.
jenlampton 767b6b3
Merge pull request #1 from jenlampton/patch-1
pirog 43ed757
Remove a few vestigal references to drupal
pirog 5303128
Fix up some MD linting chaos for backdrop
pirog c7fbd86
Remove Backdrop USER FEEDBACK section
pirog a8b19b3
Remove Backdrop SUPPORTED VERSIONS section
pirog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
The comprehensive CMS for small to medium sized businesses and non-profits. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
# What is Backdrop CMS? | ||
|
||
Backdrop CMS is a comprehensive Content Management System for small to medium sized businesses and non-profits. It is a fork of the Drupal project. | ||
|
||
Backdrop CMS enables people to build highly customized websites, affordably, through collaboration and open source software. For more on the Backdrop's philosophy see https://backdropcms.org/philosophy. | ||
|
||
%%LOGO%% | ||
|
||
# How to use this image | ||
|
||
The basic pattern for starting a `%%REPO%%` instance is: | ||
|
||
```console | ||
$ docker run --name some-%%REPO%% --link some-mysql:mysql -d %%REPO%% | ||
``` | ||
|
||
The following environment variables are also honored for configuring your Backdrop CMS instance: | ||
|
||
- `-e BACKDROP_DB_HOST=...` (defaults to the IP and port of the linked `mysql` container) | ||
- `-e BACKDROP_DB_USER=...` (defaults to "root") | ||
- `-e BACKDROP_DB_PASSWORD=...` (defaults to the value of the `MYSQL_ROOT_PASSWORD` environment variable from the linked `mysql` container) | ||
- `-e BACKDROP_DB_NAME=...` (defaults to "backdrop") | ||
- `-e BACKDROP_DB_PORT=...` (defaults to 3306) | ||
- `-e BACKDROP_DB_DRIVER=...` (defaults to "mysql") | ||
|
||
The `BACKDROP_DB_NAME` **must already exist** on the given MySQL server. Check out the [official mysql image](https://hub.docker.com/_/mysql/) for more info on spinning up a DB. | ||
|
||
If you'd like to be able to access the instance from the host without the container's IP, standard port mappings can be used: | ||
|
||
```console | ||
$ docker run --name some-%%REPO%% --link some-mysql:mysql -p 8080:80 -d %%REPO%% | ||
``` | ||
|
||
Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser. | ||
|
||
If you'd like to use an external database instead of a linked `mysql` container, specify the hostname and port with `BACKDROP_DB_HOST`/`BACKDROP_DB_PORT` along with the password in `BACKDROP_DB_PASSWORD` and the username in `BACKDROP_DB_USER` (if it is something other than `root`): | ||
|
||
```console | ||
$ docker run --name some-%%REPO%% \ | ||
-e BACKDROP_DB_HOST=10.1.2.3 \ | ||
-e BACKDROP_DB_PORT=10432 \ | ||
-e BACKDROP_DB_USER=... \ | ||
-e BACKDROP_DB_PASSWORD=... \ | ||
-d %%REPO%% | ||
``` | ||
|
||
## ... via [`docker-compose`](https://github.com/docker/compose) | ||
|
||
Example `docker-compose.yml` for `%%REPO%%`: | ||
|
||
```yaml | ||
%%REPO%%: | ||
image: %%REPO%% | ||
links: | ||
- db:mysql | ||
ports: | ||
- 8080:80 | ||
|
||
db: | ||
image: mysql | ||
environment: | ||
MYSQL_USER: %%REPO%% | ||
MYSQL_PASSWORD: %%REPO%% | ||
MYSQL_ALLOW_EMPTY_PASSWORD: 'yes' | ||
MYSQL_DATABASE: %%REPO%% | ||
|
||
``` | ||
|
||
Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`. | ||
|
||
## Adding additional libraries / extensions | ||
|
||
This image does not provide any additional PHP extensions or other libraries, even if they are required by popular plugins. There are an infinite number of possible plugins, and they potentially require any extension PHP supports. Including every PHP extension that exists would dramatically increase the image size. | ||
|
||
If you need additional PHP extensions, you'll need to create your own image `FROM` this one. The [documentation of the `php` image](https://github.com/docker-library/docs/blob/master/php/README.md#how-to-install-more-php-extensions) explains how to compile additional extensions. Additionally, the [`drupal:7` Dockerfile](https://github.com/docker-library/drupal/blob/bee08efba505b740a14d68254d6e51af7ab2f3ea/7/Dockerfile#L6-9) has an example of doing this. | ||
|
||
The following Docker Hub features can help with the task of keeping your dependent images up-to-date: | ||
|
||
- [Automated Builds](https://docs.docker.com/docker-hub/builds/) let Docker Hub automatically build your Dockerfile each time you push changes to it. | ||
- [Repository Links](https://docs.docker.com/docker-hub/builds/#repository-links) can ensure that your image is also rebuilt any time `backdrop` is updated. | ||
|
||
# License | ||
|
||
View [license information](https://backdropcms.org/license) for the software contained in this image. | ||
|
||
# Supported Docker versions | ||
|
||
This image is officially supported on Docker version 1.10.3. | ||
|
||
Support for older versions (down to 1.6) is provided on a best-effort basis. | ||
|
||
Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon. | ||
|
||
# User Feedback | ||
|
||
## Documentation | ||
|
||
> https://github.com/backdrop-ops/backdrop-docker/wiki | ||
|
||
## Issues | ||
|
||
> https://github.com/backdrop-ops/backdrop-docker/issues | ||
|
||
## Contributing | ||
|
||
> https://github.com/backdrop-ops/backdrop-docker |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
View [license information](https://backdropcms.org/license) for the software contained in this image. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section and the "User Feedback" sections are generated by the update script. If you want a custom "User Feedback" section not based upon .template-helpers/user-feedback.md, then just put it in a
user-feedback.md
in thisbackdrop/
folder.