{"id":15025639,"url":"https://github.com/gentics/portal-php-reference","last_synced_at":"2026-03-04T20:03:44.280Z","repository":{"id":53019605,"uuid":"153621417","full_name":"gentics/portal-php-reference","owner":"gentics","description":"GENTICS PORTAL | php docker-compose files, base for a new project \u0026 demo","archived":false,"fork":false,"pushed_at":"2024-12-12T12:38:35.000Z","size":4450,"stargazers_count":3,"open_issues_count":11,"forks_count":2,"subscribers_count":15,"default_branch":"newproject","last_synced_at":"2025-04-09T20:03:43.362Z","etag":null,"topics":["composer","docker","docker-compose","laravel","laravel-application","php","php-framework","php-library","php7","php71"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/gentics.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}},"created_at":"2018-10-18T12:38:22.000Z","updated_at":"2022-10-24T21:13:17.000Z","dependencies_parsed_at":"2025-02-15T19:31:25.448Z","dependency_job_id":"1636911c-bdcf-42d8-8544-f766766cc616","html_url":"https://github.com/gentics/portal-php-reference","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gentics/portal-php-reference","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gentics%2Fportal-php-reference","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gentics%2Fportal-php-reference/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gentics%2Fportal-php-reference/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gentics%2Fportal-php-reference/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gentics","download_url":"https://codeload.github.com/gentics/portal-php-reference/tar.gz/refs/heads/newproject","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gentics%2Fportal-php-reference/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30091580,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T19:41:02.502Z","status":"ssl_error","status_checked_at":"2026-03-04T19:40:05.550Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["composer","docker","docker-compose","laravel","laravel-application","php","php-framework","php-library","php7","php71"],"created_at":"2024-09-24T20:02:43.408Z","updated_at":"2026-03-04T20:03:44.254Z","avatar_url":"https://github.com/gentics.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gentics Portal | php - Reference\n\nThis repository contains both, an example docker compose stack for creating a new project with Gentics Portal | php, Gentics Mesh and Gentics CMS and an easy to start demo application showing the most important features of Gentics Portal | php\n\n## Branches\n\n| Branch     | Description       |  Documentation |\n|------------|-------------------| ---------------|\n| newproject | For creating a fresh new project with Gentics Portal php | [Link](#creating-a-new-laravel-project-with-gentics-portal--php) |\n| demo       | Demo reference application | [Link](README.demo.md) |\n\n## Requirements\n\n* [GIT](https://git-scm.com/download/win)\n* [Docker](https://docs.docker.com/install/) - Latest version\n* [Docker Compose](https://docs.docker.com/compose/install/) - Latest version\n* [PHP](http://php.net/downloads.php) - 8.1 (\u003e=8.1.7)\n* [Composer v2](https://getcomposer.org/doc/00-intro.md)\n\n**Important: When using Windows, you must configure your GIT client to not convert line endings to windows line endings BEFORE cloning this GIT repository.**\n\n```\ngit config --global core.autocrlf input\n```\n\nRead the section [\"Installing the requirements\"](#installing-the-requirements) for more specific details on how to install and configure the required tools.\nIf you encounter any errors, you maybe find a solution on [this page here](https://github.com/gentics/cms-compose/wiki/Common-problems-\u0026-FAQ).\n\n### Authentication for repo.apa-it.at\n\nContact Gentics if you haven't received your credentials for repo.apa-it.at yet.\n\nOpen the composer file auth.json. You can also edit `%USERPROFILE%\\AppData\\Roaming\\Composer\\auth.json` or `~/.composer/auth.json` instead.\n\n```bash\ncomposer config --global --auth --editor\n```\n\nMake sure your auth.json contains the following configuration:\n\n```\n{\n    \"http-basic\": {\n        \"repo.apa-it.at\": {\n            \"username\": \"MYUSERNAME\",\n            \"password\": \"MYPASSWORD\"\n        }\n    }\n}\n```\n\nReplace `MYUSERNAME` and `MYPASSWORD`. Use the API key as password, which can be generated/retrieved in the Artifactory profile page.\n\nLog in into the docker registry and use the same credentials like above:\n\n```\ndocker login repo.apa-it.at\n```\n\n## Running the demo\n\nSee: https://github.com/gentics/portal-php-reference/blob/demo/README.demo.md\n\n## Creating a new Laravel project with Gentics Portal | php\n\nThis explains how to setup a basic Laravel project with the portal-php package.\n\n### Create a new Laravel project with Gentics Portal | php\n\n```bash\ncomposer create-project gentics/portal-php-laravel-project portal --repository-url \"https://repo.apa-it.at/api/composer/php\"\n```\n\nThis adds the repository \"gentics\" to your projects composer.json, pulls the dependencies and copies some default files from the portal-php package.\n\n### .htaccess\n\nPOST requests from the CMS to the CmsController do not work by default because the stock Laravel .htaccess redirects all requests that have a trailing slash in order to remove it.\nHowever due do the RFC standard which disallows POST redirects without user interaction, this means that the POST data is lost.\n\nWe can fix this easily, in `portal/public/.htaccess` find this line (line 12):\n\n```apache\n# Redirect Trailing Slashes If Not A Folder...\n```\n\nAdd this after:\n\n```apache\nRewriteCond %{REQUEST_METHOD} =GET\n```\n\n### Docker service configuration\n\nCopy the file `docker-compose.override.yml.example` to `docker-compose.override.yml`\nYou can configure passwords, ports, environment variables and other settings `in docker-compose.override.yml`\nThe license key for the cms has to be changed.\n\n### Running the portal\n\n#### Copy `docker-compose.override.yml.example` to `docker-compose.override.yml`\n\nYou can configure passwords, ports, environment variables and other settings `in docker-compose.override.yml`\nThe license key for the cms has to be changed.\n\n#### Copy `portal/.env.example` to `portal/.env`\n\nThis file contains the environment settings for the Laravel framework.\n\nRun:\n\n```bash\ndocker-compose up -d\n```\n\n* You can view the container status with `docker-compose ps`\n* To view the logs of a specific container, use `docker-compose logs -f name`. e.g.: `docker-compose logs -f portal`\n* You can read [this page here](https://github.com/gentics/cms-compose/wiki/Common-problems-\u0026-FAQ) if you encounter any problems.\n\n#### Disable automatic Mesh API Key generation\n\nSet `AUTOGENERATE_MESH_API_KEY` environment variable to false for the portal.\n\n#### Open the reference project in the browser\n\n##### Portal application\n\nhttp://localhost:8080 - If asked for authentication, register a new account (Keycloak)\n\n##### Mesh\n\nhttp://localhost:8081 - Use admin admin as login\n\n##### CMS\n\nhttp://localhost:8082 - Use node node as login\n\n## Service documentation:\n\n* [mesh](https://getmesh.io/docs/beta/administration-guide.html#_environment_variables)\n* [elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html)\n* [cms](https://hub.docker.com/r/gentics/cms/)\n* [db](https://hub.docker.com/_/mariadb/)\n\n## Howto\n\n### Installing the requirements\n\n#### GIT\n\n##### Windows\n\nInstall the GIT client from https://git-scm.com/downloads\n\nMake sure to enable \"Checkout as-is, commit Unix-style\" when the installer asks you.\n\n##### Linux / Mac ####\n\nInstall the package \"git\" with the packet manager.\n\n#### Docker\n\nMinimum Hardware Requirements:\n- CPU: x86, 2 cores\n- Memory: 8 GB RAM\n- Disk: 15 GB free space\n\n#### Windows / Mac ####\n\n* Use Docker with WSL2 if available\n* We recommend to increase the memory to at least 6 GB and set the available CPU at least 2 cores in the Docker settings\n\n#### PHP\n\nCheck if PHP 8.1.7 or higher is already installed by running `php -version`\n\nIf your operating system has a packet manager with PHP 8.1.7 or higher, install the package, otherwise download PHP from https://windows.php.net/download#php-8.1 (PHP 8.1 \"VS16 x64 Non Thread Safe\" for Windows).\n\n### Building the Dockerfile\n\nIf you do any changes do the Dockerfile or files in `portal-files`, you have to run\n\n```bash\ndocker-compose build\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgentics%2Fportal-php-reference","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgentics%2Fportal-php-reference","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgentics%2Fportal-php-reference/lists"}