{"id":40723379,"url":"https://github.com/0xffff-one/flarum-0x","last_synced_at":"2026-01-21T13:40:09.619Z","repository":{"id":38013518,"uuid":"228651106","full_name":"0xffff-one/flarum-0x","owner":"0xffff-one","description":"🔧 Customized Flarum for the 0xFFFF Community.","archived":false,"fork":false,"pushed_at":"2025-11-27T05:57:17.000Z","size":4778,"stargazers_count":47,"open_issues_count":9,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-29T22:38:20.174Z","etag":null,"topics":["flarum","laravel","php"],"latest_commit_sha":null,"homepage":"https://0xffff.one","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0xffff-one.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2019-12-17T15:55:50.000Z","updated_at":"2025-11-27T05:57:23.000Z","dependencies_parsed_at":"2023-11-24T17:30:41.729Z","dependency_job_id":"0c94112a-874c-4f11-9817-48b5338cc28d","html_url":"https://github.com/0xffff-one/flarum-0x","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/0xffff-one/flarum-0x","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xffff-one%2Fflarum-0x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xffff-one%2Fflarum-0x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xffff-one%2Fflarum-0x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xffff-one%2Fflarum-0x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xffff-one","download_url":"https://codeload.github.com/0xffff-one/flarum-0x/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xffff-one%2Fflarum-0x/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28633801,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["flarum","laravel","php"],"created_at":"2026-01-21T13:40:09.561Z","updated_at":"2026-01-21T13:40:09.611Z","avatar_url":"https://github.com/0xffff-one.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Flarum 0x\nCustomized [flarum](https://github.com/flarum/flarum) for the [0xFFFF Community](https://0xffff.one/).\n\nWe are working on:\n\n1. Customisation based on the 0xFFFF Community needs.\n2. A modern, cloud-based Flarum Development \u0026 Deployment workflow.\n3. Encourage more people to participate and contribute to the Flarum Community.\n\n## Customizations\nThe customizations of **Flarum 0x** consists of these parts:\n1. Initialized [Flarum Skeleton](https://github.com/flarum/flarum) with our custom `composer.json` / `composer.lock` config (contains the extensions we are using).\n2. Patches for the extensions in `vendor/` to make some small changes without publishing new Composer Packages (see [patches/README.md](patches/README.md)).\n3. Custom [flarum extenders](https://docs.flarum.org/extend/start#extenders) in `extend.php`.\n4. Custom third party extension integrated into this repo as submodules.\n\nThe features we have customised include:\n1. Support global assets CDN config.\n2. Save avatars to S3-compatible Storage instead of local disk (thanks to [askvortsov1/flarum-azure-poc](https://github.com/askvortsov1/flarum-azure-poc)).\n3. Add support for [blomstra/flarum-redis](https://github.com/blomstra/flarum-redis) extension (for Queue / Cache / Session), enable the Queue Worker to consume the [Background Tasks](https://docs.flarum.org/internal/package-manager#background-tasks) asynchronously.\n4. Add support for custom head HTML like add some `\u003cscript\u003e` / `\u003clink\u003e` / `\u003cmeta\u003e` tags in `config.php`.\n5. Replace some hard-coded JsDelivr resource URLs with ByteDance's cdn (for mainland China users).\n6. All the extensions required at `composer.json`\n7. ...\n\n## Local Development Env Setup\nWe are using [Development Containers](https://containers.dev/) with our LNMP config to save the time required to configure the environment.\n\nSteps to configure your local development environment:\n1. Install Docker (Docker Desktop / Docker CE / OrbStack, etc...) on your dev machine.\n2. Install VSCode and [Dev Containers VSCode extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).\n3. Just clone this repository and use VSCode open it, then VSCode would notify you to open the repository in the Dev Container.\n4. After the Dev Container has initialised, open `http://localhost:8080` and see your Flarum app instance (It will automatically forward the ports to local).\n\nOr you can just create a new GitHub codespace with this repo, then start development.\n\n## Production Deployment\nBasically running a **Flarum 0x** website requires two Docker container instances.\n\n1. **Flarum 0x**, latest pre-built image: `ghcr.io/0xffff-one/flarum-0x:latest`.\n2. **A MySQL-compatible DBMS**, MySQL, MariaDB or other, use MySQL with [ngram](https://dev.mysql.com/doc/refman/5.7/en/fulltext-search-ngram.html) support for CJK full-text search.\n\nYou can deploy them via [Docker Compose](./docker-compose.yml).\n\n## Contribution\nAny contributions are welcome. Please feel free to:\n\n* Open an Issue\n* Create a Pull Request\n* Comment in an Issue / PR / commit\n* Open a Discussion in [0xFFFF Forum](https://0xffff.one/) / Discord / QQ Group\n\nThank you for willing to contribute to this project!\n\n### TODO\n\n - [x] new Dev Envionment setup config\n - [x] build process for Front-end Patching\n - [x] Update latest README.md about Dev Env setup and Production deployment\n - [x] Optimize the production Docker image config\n\n## Contributors\nThis project exists thanks to all the people who contribute.\n\n\u003ca href=\"https://github.com/0xffff-one/flarum-0x/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=0xffff-one/flarum-0x\" /\u003e\n\u003c/a\u003e\n\n## Reference\n * [Flarum Community](https://discuss.flarum.org/)\n * [Flarum Documentation](https://docs.flarum.org/)\n * [Extending Flarum | Flarum Documentation](https://docs.flarum.org/extend/)\n * [Flarum 中文社区](https://discuss.flarum.org.cn/)\n * [ECNU-Forum/ECNU-Forum](https://github.com/ECNU-Forum/ECNU-Forum)\n\n## License\n\nFlarum is open-source software licensed under the [MIT License](https://github.com/flarum/flarum/blob/master/LICENSE).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xffff-one%2Fflarum-0x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xffff-one%2Fflarum-0x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xffff-one%2Fflarum-0x/lists"}