| Name | wordpress-docker-setup JSON |
| Version |
1.9.0
JSON |
| download |
| home_page | None |
| Summary | This is a script to create a docker-compose project for a wordpress site with a nginx reverse proxy. The script will create the configuration files for the project and start the containers as well as install the nginx reverse proxy configuration. *See the usage section for more information.* |
| upload_time | 2024-07-31 23:00:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
wordpress
docker
nginx
reverse proxy
script
setup
configuration
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Wordpress-Installation-Script
> ```bash
> # =============================================================================
> # Copyright (C) 2024 Frederik Beimgraben
> #
> # This program is free software: you can redistribute it and/or modify
> # it under the terms of the GNU General Public License as published by
> # the Free Software Foundation, either version 3 of the License, or
> # (at your option) any later version.
> #
> # This program is distributed in the hope that it will be useful,
> # but WITHOUT ANY WARRANTY; without even the implied warranty of
> # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> # GNU General Public License for more details.
> #
> # You should have received a copy of the GNU General Public License
> # along with this program. If not, see <https://www.gnu.org/licenses/>.
> # =============================================================================
> ```
## Installation
### Using Makefile and Cython
```bash
# Compile the script to an executable using Cython:
make
# Copy the executable to a folder in your PATH (e.g. /usr/local/bin):
sudo cp wordpress_install /usr/local/bin/
```
### From PyPI
```bash
# Install the script from PyPI:
pip install wordpress-docker-setup
```
# WHAT IS THIS?
This is a script to create a docker-compose project for a wordpress site with a nginx reverse proxy. The script will create the configuration files for the project and start the containers as well as install the nginx reverse proxy configuration. *See the usage section for more information.*
# Usage
```txt
Usage of the script:
python3 wordpress_setup.py [ { -I [ -C ] | -U } ] [ -n <hostname> ] [ -p <port> ] [ -m <mount_folder> ] [ -d <db_passwd> ] [ -r <db_passwd_root> ]
[no action options]:
Create configuration files for a new project in the current directory
-I: Install the project
-C: Start Certbot to get a certificate for the domain
-U: Uninstall the project
-R: Clean the project (remove all files)
-i: Interactive mode (ask for the following options)
-s: Silent mode (don't show prompts)
-n: The hostname of the site (default: localhost)
-p: The port of the site (default: 8080)
-m: The folder to mount the database data (default: db_data)
-d: The password for the database user (default: <random>)
-r: The password for the database root user (default: <random>)
-h: Show this help message
The script will create a docker-compose.yml file and a .env file in the
current directory. The .env file will contain the passwords for the database
users as well as the hostname and port of the site. The docker-compose.yml
file will contain the configuration for the wordpress site and the nginx
reverse proxy. The script will also create a folder for the database data
of the wordpress site.
If the -I option is used, the script will:
- Create the configuration files
- Start the containers
- Install the nginx reverse proxy configuration
If the -C option is used, the script will:
- Start Certbot to get a certificate for the domain
If the -U option is used, the script will:
- Stop the containers
- Remove the containers
- Uninstall the nginx reverse proxy configuration
If the -c option is used, the script will:
- Clean the project (remove all files)
The script will check if the required programs are installed. Furthermore
it will check if the DNS-Configuration is correct for the setup to work
when requesting a certificate with Certbot.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "wordpress-docker-setup",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Frederik Beimgraben <frederik@beimgraben.net>",
"keywords": "wordpress, docker, nginx, reverse proxy, script, setup, configuration",
"author": null,
"author_email": "Frederik Beimgraben <frederik@beimgraben.net>",
"download_url": "https://files.pythonhosted.org/packages/77/77/feb8e310a58779ffaa8a76bca1985c940536dc972b24d77c8cdb271aab1c/wordpress_docker_setup-1.9.0.tar.gz",
"platform": null,
"description": "# Wordpress-Installation-Script\n> ```bash\n> # =============================================================================\n> # Copyright (C) 2024 Frederik Beimgraben\n> #\n> # This program is free software: you can redistribute it and/or modify\n> # it under the terms of the GNU General Public License as published by\n> # the Free Software Foundation, either version 3 of the License, or\n> # (at your option) any later version.\n> #\n> # This program is distributed in the hope that it will be useful,\n> # but WITHOUT ANY WARRANTY; without even the implied warranty of\n> # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n> # GNU General Public License for more details.\n> #\n> # You should have received a copy of the GNU General Public License\n> # along with this program. If not, see <https://www.gnu.org/licenses/>.\n> # =============================================================================\n> ```\n\n## Installation\n### Using Makefile and Cython\n```bash\n# Compile the script to an executable using Cython:\nmake\n# Copy the executable to a folder in your PATH (e.g. /usr/local/bin):\nsudo cp wordpress_install /usr/local/bin/\n```\n\n### From PyPI\n```bash\n# Install the script from PyPI:\npip install wordpress-docker-setup\n```\n\n# WHAT IS THIS?\nThis is a script to create a docker-compose project for a wordpress site with a nginx reverse proxy. The script will create the configuration files for the project and start the containers as well as install the nginx reverse proxy configuration. *See the usage section for more information.*\n\n# Usage\n```txt\nUsage of the script:\n python3 wordpress_setup.py [ { -I [ -C ] | -U } ] [ -n <hostname> ] [ -p <port> ] [ -m <mount_folder> ] [ -d <db_passwd> ] [ -r <db_passwd_root> ]\n\n [no action options]:\n Create configuration files for a new project in the current directory\n\n -I: Install the project\n -C: Start Certbot to get a certificate for the domain\n -U: Uninstall the project\n -R: Clean the project (remove all files)\n\n -i: Interactive mode (ask for the following options)\n -s: Silent mode (don't show prompts)\n\n -n: The hostname of the site (default: localhost)\n -p: The port of the site (default: 8080)\n -m: The folder to mount the database data (default: db_data)\n -d: The password for the database user (default: <random>)\n -r: The password for the database root user (default: <random>)\n\n -h: Show this help message\n\n The script will create a docker-compose.yml file and a .env file in the\n current directory. The .env file will contain the passwords for the database\n users as well as the hostname and port of the site. The docker-compose.yml\n file will contain the configuration for the wordpress site and the nginx\n reverse proxy. The script will also create a folder for the database data\n of the wordpress site.\n\n If the -I option is used, the script will:\n - Create the configuration files\n - Start the containers\n - Install the nginx reverse proxy configuration\n\n If the -C option is used, the script will:\n - Start Certbot to get a certificate for the domain\n\n If the -U option is used, the script will:\n - Stop the containers\n - Remove the containers\n - Uninstall the nginx reverse proxy configuration\n\n If the -c option is used, the script will:\n - Clean the project (remove all files)\n\n The script will check if the required programs are installed. Furthermore\n it will check if the DNS-Configuration is correct for the setup to work\n when requesting a certificate with Certbot.\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "This is a script to create a docker-compose project for a wordpress site with a nginx reverse proxy. The script will create the configuration files for the project and start the containers as well as install the nginx reverse proxy configuration. *See the usage section for more information.*",
"version": "1.9.0",
"project_urls": {
"Homepage": "https://github.com/frederikbeimgraben/Wordpress-Installation-Script",
"Issues": "https://github.com/frederikbeimgraben/Wordpress-Installation-Script/issues",
"Repository": "https://github.com/frederikbeimgraben/Wordpress-Installation-Script"
},
"split_keywords": [
"wordpress",
" docker",
" nginx",
" reverse proxy",
" script",
" setup",
" configuration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "10cac55ce3f7831cd3b09602837e887938486f0ebaa0bcfdfa435874a0de1cba",
"md5": "c6ddd2b070eefc1609080517a40b8be9",
"sha256": "4248f8cec3d3e334b28c261310e366748a087b9e081b71416e1906cd8e931ecb"
},
"downloads": -1,
"filename": "wordpress_docker_setup-1.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c6ddd2b070eefc1609080517a40b8be9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22828,
"upload_time": "2024-07-31T23:00:26",
"upload_time_iso_8601": "2024-07-31T23:00:26.089911Z",
"url": "https://files.pythonhosted.org/packages/10/ca/c55ce3f7831cd3b09602837e887938486f0ebaa0bcfdfa435874a0de1cba/wordpress_docker_setup-1.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7777feb8e310a58779ffaa8a76bca1985c940536dc972b24d77c8cdb271aab1c",
"md5": "8f6c21833fb945b142cbc8a2ccc27c73",
"sha256": "52ac4c5a8155464950744fc32df99daec1a4fddf3f3a6d26850aac61c10f8be5"
},
"downloads": -1,
"filename": "wordpress_docker_setup-1.9.0.tar.gz",
"has_sig": false,
"md5_digest": "8f6c21833fb945b142cbc8a2ccc27c73",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21748,
"upload_time": "2024-07-31T23:00:27",
"upload_time_iso_8601": "2024-07-31T23:00:27.461504Z",
"url": "https://files.pythonhosted.org/packages/77/77/feb8e310a58779ffaa8a76bca1985c940536dc972b24d77c8cdb271aab1c/wordpress_docker_setup-1.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-31 23:00:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "frederikbeimgraben",
"github_project": "Wordpress-Installation-Script",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wordpress-docker-setup"
}
