{"id":48536606,"url":"https://github.com/ucsc/wp-dev.ucsc","last_synced_at":"2026-04-08T02:03:56.647Z","repository":{"id":66712467,"uuid":"557517184","full_name":"ucsc/wp-dev.ucsc","owner":"ucsc","description":"A Docker WordPress Local Environment with HTTPS \u0026 LDAP","archived":false,"fork":false,"pushed_at":"2026-01-20T17:16:52.000Z","size":37,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-21T02:24:29.778Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ucsc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-10-25T20:40:24.000Z","updated_at":"2026-01-20T17:16:57.000Z","dependencies_parsed_at":"2025-10-20T23:20:23.128Z","dependency_job_id":"3932a971-7552-4c70-86e4-801e98a80db4","html_url":"https://github.com/ucsc/wp-dev.ucsc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ucsc/wp-dev.ucsc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucsc%2Fwp-dev.ucsc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucsc%2Fwp-dev.ucsc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucsc%2Fwp-dev.ucsc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucsc%2Fwp-dev.ucsc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ucsc","download_url":"https://codeload.github.com/ucsc/wp-dev.ucsc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ucsc%2Fwp-dev.ucsc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31536473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"online","status_checked_at":"2026-04-08T02:00:06.127Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-08T02:03:33.546Z","updated_at":"2026-04-08T02:03:56.627Z","avatar_url":"https://github.com/ucsc.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker Environment for UCSC WordPress theme and plugins\n\n## Prerequisites\n\n1. The instructions assume you have git and [Docker](https://www.docker.com/products/docker-desktop/) installed. Have the docker app open while going through the steps. \n2. You need a [UCSC VPN connection](https://its.ucsc.edu/vpn/) to use the *Campus Directory* block in the [UCSC Gutenberg Blocks plugin](https://github.com/ucsc/ucsc-gutenberg-blocks).\n\n## Setup\n\n1. Go to your terminal and run this command to clone this repo\n      * `git clone https://github.com/ucsc/wp-dev.ucsc.git`\n      * cd into the folder `cd wp-dev.ucsc`\n\n2. Edit your hosts file by running `sudo nano /etc/hosts` in your terminal and add `127.0.0.1  wp-dev.ucsc`\n    * On Mac OS do ctrl+O to writeout and hit enter on your keyboard\n    * Then hit ctrl+X to exit\n    * You have now successfully edited you host file.\n      \n3. Change `.env.example.txt` to `.env` by following these steps:\n      * cd into the folder `cd wp-dev.ucsc` if you are not in it already\n      * Run the command `ls -a` to see hidden files and verify there is a file called `.env.example.txt`\n      * Run this command to change the name to .env `mv .env.example.txt .env`\n      * Run ls -a to verify the name of the file has changed to `.env`\n     \n4. In the wp-dev.ucsc directory build and start the WordPress server with HTTPS \u0026 PHP LDAP module (Allow time for this command to finish)\n     * `docker compose up -d`\n     * Once this is finished running you should have a total of 5 docker containers up and running. You can verify this by opening up the docker app and\n       making sure there is a green dot next to each container.\n     * Troubleshooting: If there is not a green dot next to each container then here is what you should do: select all the containers in your docker app and\n       delete them all. Once all the containers have been deleted go to your terminal in the wp-dev.ucsc directory and run `docker compose up -d` again.\n       This should solve the issue and have all 5 containers up and running succesfully.\n       \n       \n\n\u003e [!IMPORTANT]  \n\u003e Check that a `wp-config.php` file exists in the `./public/` folder before proceeding\n\n5. Run the following script to clone the theme and plugins to the correct project directories.\n      * `./setup.sh`\n\n6. Next we install WordPress, activate the theme \u0026 plugin, run composer install on the theme as well as npm install on both the plugin and the theme\n     * `docker compose -f docker-compose-install.yml run theme_composer_install`\n     * `docker compose -f docker-compose-install.yml run theme_npm_install`\n     * `docker compose -f docker-compose-install.yml run plugin_npm_install` (may take up to 2 minutes to complete)\n     * `docker compose -f docker-compose-install.yml run wordpress_install`\n\nYour installation is now complete.\n\nTroubleshooting: If there is not a green dot next to each container then here is what you should do: select all the containers in your docker app and\ndelete them all. Once all the containers have been deleted go to your terminal in the wp-dev.ucsc directory and run `docker compose up -d` again.\nThis should solve the issue and have all 5 containers up and running succesfully.\n\n## Running the Docker services for development\n\nNow that WordPress is installed and the plugins and theme are built, we can start watching for changes to code and rebuild when necessary\n\n* Starts the WordPress server environment\n  * `docker compose up -d`\n* Starts the Node development environments for the theme and blocks plugin\n  * `docker compose -f docker-compose-start.yml up -d`\n\n\u003e [!TIP]  \n\u003e Swap `up` with `down` in the commands above to stop your containers. You must run both commands to start and stop the development environments.\n\n## In Your Browser\nAt this point you should be able to visit https://wp-dev.ucsc/wp-admin in a browser. In Google Chrome you will get a error saying \"Your connection is not private\", this is due to the local certificates. You can click Advanced -\u003e proceed to wp-dev.ucsc. To login:\n\n* username: `admin`\n* password `password`\n\n\u003e [!TIP]\n\u003e \n\u003e * You can run WP-CLI commands with `docker exec ${NAME}-cli wp \u003cCOMMAND\u003e`\n\u003e * `${NAME}` is what you used in your `.env` file\n\n\n## VScode/Xdebug setup\n\nThe [PHP Debug plugin](https://marketplace.visualstudio.com/items?itemName=xdebug.php-debug) is required. On the debug tab click `Create a launch.json file` and select type `php`.\n\nYou can replace the contents of `launch.json` with the following:\n\n```json\n{\n  \"version\": \"0.2.0\",\n  \"configurations\": [\n    {\n      \"name\": \"Listen for Xdebug\",\n      \"type\": \"php\",\n      \"request\": \"launch\",\n      \"port\": 9003,\n      \"pathMappings\": {\n        \"/var/www/html/wp-content/plugins/ucsc-gutenberg-blocks\": \"${workspaceRoot}\"\n      },\n      \"hostname\": \"wp-dev.ucsc\"\n    }\n  ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucsc%2Fwp-dev.ucsc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fucsc%2Fwp-dev.ucsc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fucsc%2Fwp-dev.ucsc/lists"}