{"id":15017027,"url":"https://github.com/mollusc-labs/clark","last_synced_at":"2025-06-14T00:02:40.924Z","repository":{"id":153534274,"uuid":"615497407","full_name":"mollusc-labs/clark","owner":"mollusc-labs","description":"Modern logging dashboard and REST API for syslog","archived":false,"fork":false,"pushed_at":"2024-03-30T04:28:35.000Z","size":378,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-31T03:34:06.883Z","etag":null,"topics":["dashboard","hacktoberfest","logging","perl","perl5","rest","rsyslog","typescript","vue"],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mollusc-labs.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":"2023-03-17T20:49:23.000Z","updated_at":"2023-09-24T21:02:57.000Z","dependencies_parsed_at":"2024-03-30T05:20:55.875Z","dependency_job_id":"4bcce505-a4a3-433f-b103-98e6ce342d61","html_url":"https://github.com/mollusc-labs/clark","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mollusc-labs/clark","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mollusc-labs%2Fclark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mollusc-labs%2Fclark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mollusc-labs%2Fclark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mollusc-labs%2Fclark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mollusc-labs","download_url":"https://codeload.github.com/mollusc-labs/clark/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mollusc-labs%2Fclark/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259737866,"owners_count":22903867,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["dashboard","hacktoberfest","logging","perl","perl5","rest","rsyslog","typescript","vue"],"created_at":"2024-09-24T19:49:42.524Z","updated_at":"2025-06-14T00:02:40.294Z","avatar_url":"https://github.com/mollusc-labs.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Clark\nA free and open-source logging dashboard, and REST API for `rsyslog` and theoretically any other syslog-daemon.\nTo get started, checkout the `QUICKSTART.md` file at the root of the project.\n\n![image](https://user-images.githubusercontent.com/75388349/232936550-233012d6-a2e4-402a-878a-7401902152c7.png)\n\n## TODO\nClark is currently in a work-in-progress state. The following things still need to be done:\n\n- [X] Make login page nice\n- [ ] User and privilege management\n- [ ] Ability to change your password\n- [X] Time boxed dashboards\n- [X] Logging via rsyslog\n- [X] REST API\n- [ ] Graphs\n- [X] Log-in\n- [X] Custom dashboards\n- [X] Api Keys \n- [X] Full-text search\n\n## How to use\n1. Make sure you have Perl \u003e5.10 and the following packages installed:\n    - On Ubuntu you can install them like this:\n        ```\n        sudo apt install libio-prompter-perl libterm-readkey-perl\n        ```\n    - Or on other distros with CPAN:\n        ```\n        sudo cpan install IO::Prompter Term::ReadKey\n        ```\n2. Run Clarks system configuration script: `./setup.pl`\n3. Make sure you have `docker` and `docker compose`\n4. Run the following commands to install and run Clark (the first install may take a few minutes):\n    ```bash\n    git clone https://github.com/mollusc-labs/clark\n    cd clark\n    docker-compose up -d\n    ```\n5. Read `QUICKSTART.md` to figure out what logging configuration works for you!\n6. Happy logging!\n\n## Use in production\nIt is highly recommended to place Clark behind a proxy like `NGiNX`, `httpd` or similar, before exposing it to the internet.\nYou will also want to ensure that you are using `HTTPS`.\n\n## Troubleshooting\n\n#### Port is closed\n`setup.pl` will configure `rsyslog` to use port `514` for both UDP and TCP traffic, some people may want to change these\nor are simply unable to open these ports. In that case edit `rsyslog.d/remote.conf` to use whatever port you'd like.\n\n#### Firewalls\nIf you plan to log over the internet (not recommended outside of the REST API) you will need to open the port specified\nin the `rsyslog.d/remote.conf`, this is defaulted to `514` for both TCP and UDP.\n\n## Contributing\nClark is a Perl application using `Mojolicious` that uses a `Vue3` frontend. Any and all contributions will be considered!\nMake sure your Perl code follows the `.perltidyrc`'s configuration before you make any pull-requests. Thanks!\n\n#### How to run in development\nRun `docker-compose up -d clark_database` and `setup.pl`, then install all of the CPAN dependencies listed in the `cpanfile`.\n\nNow you can run the frontend with `cd frontend \u0026\u0026 yarn dev`, and the backend with `./dev.sh`.\n\n## License\nClark is licensed under the `BSD-3 Clause` license, to learn more, please view the `LICENSE` file at the root of\nthe project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmollusc-labs%2Fclark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmollusc-labs%2Fclark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmollusc-labs%2Fclark/lists"}