{"id":23078313,"url":"https://github.com/imide/logviewer","last_synced_at":"2025-10-12T04:43:21.739Z","repository":{"id":157860909,"uuid":"579447215","full_name":"imide/Logviewer","owner":"imide","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-26T01:43:14.000Z","size":428,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-12T04:43:20.535Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imide.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-12-17T18:18:53.000Z","updated_at":"2022-12-17T18:19:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"8f8d0ac9-b646-40b2-9545-f5a40861b468","html_url":"https://github.com/imide/Logviewer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/imide/Logviewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imide%2FLogviewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imide%2FLogviewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imide%2FLogviewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imide%2FLogviewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imide","download_url":"https://codeload.github.com/imide/Logviewer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imide%2FLogviewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279010283,"owners_count":26084720,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"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":"2024-12-16T10:53:08.294Z","updated_at":"2025-10-12T04:43:21.735Z","avatar_url":"https://github.com/imide.png","language":"Python","funding_links":["https://patreon.com/kyber"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ch1\u003eModmail Log Viewer\u003c/h1\u003e\n    \u003cstrong\u003e\u003ci\u003eA simple webserver to view your selfhosted modmail logs.\u003c/i\u003e\u003c/strong\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://heroku.com/deploy?template=https://github.com/kyb3r/logviewer\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/deploy_to-heroku-997FBC.svg?style=for-the-badge\" alt=\"Deploy to Heroku\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://discord.gg/etJNHCQ\"\u003e\n      \u003cimg src=\"https://img.shields.io/discord/515071617815019520.svg?label=Discord\u0026logo=Discord\u0026colorB=7289da\u0026style=for-the-badge\" alt=\"Support\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://patreon.com/kyber\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/patreon-donate-orange.svg?style=for-the-badge\u0026logo=Patreon\" alt=\"Donate on Patreon\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://www.python.org/downloads/\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/Made%20With-Python%203.9-blue.svg?style=for-the-badge\u0026logo=Python\" alt=\"Made with Python 3.9\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/psf/black\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/Code%20Style-Black-black?style=for-the-badge\" alt=\"Coding Style Black\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/kyb3r/logviewer/blob/master/LICENSE\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/license-agpl-e74c3c.svg?style=for-the-badge\" alt=\"AGPL License\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n## What is this?\n\nIn order for you to view your self-hosted logs, you have to deploy this application. Before you deploy the application, create a config var named `MONGO_URI` and put your MongoDB connection URI from the previous section into the value slot. Take the URL of this app after you deploy it and input it as a config var `LOG_URL` in the Modmail bot app.\n\n## Updating\n\nYou can automatically update the logviewer in your Heroku account whenever changes are made to this repo.\n\nTo enable auto-updates, fork this repo and [install the Pull app in your fork](https://github.com/apps/pull). Then go to the Deploy tab in your Heroku account, select GitHub and connect your fork. Turn on auto-deploy for the master branch.\n\n## Self-Hosting Setup\n\nThe method of hosting the logviewer depends on your server configurations. \n\nBelow are some general instructions to help you get started on a Linux machine.\n\n### Prerequisites\n\n- A [Python 3.9 installation](https://www.python.org/downloads/) with `pip`\n- `git` for your system\n\ne.g. on Ubuntu: \n```shell\nsudo apt install software-properties-common python3.9 python3-dev python3-pip\n```\n\n\n### Deployment\n\nRun the following shell commands:\n```shell\ngit clone https://github.com/kyb3r/logviewer\ncd logviewer\npython3 -m pip install pipenv\npipenv install\ncp .env.example .env\n```\nEdit the `.env` file (e.g. `nano .env`) and fill in your MongoDB connection URI. \n\n\u003e You can also customize the bind IP and port in the `.env` file.\n\nThen to start the app, run:\n```shell\npipenv run logviewer\n```\n\nYou can verify the logviewer is working by navigating to `http://\u003cIP_OF_SERVER\u003e:8000` (if you didn't change the bind IP / port) and should be greeted with the Logviewer main page.\n\nTo run the program in the background, you can use `screen`. Or you can use a service manager, such as `systemd`, which can also auto-restart the logviewer on failure and after system reboot.\n\n### Advanced\n\nWe recommend setting up Nginx reverse proxy to port forward external port 80 to your internal logviewer port and cache static web contents ([tutorial](https://www.hostinger.com/tutorials/how-to-set-up-nginx-reverse-proxy/)).\n\nTo accept requests from a domain instead of your server IP, simply set an `A`/`AAAA` record from your DNS record manager that forwards your domain to your server IP.\n\n## Discord OAuth2 \n\nProtecting your logs with a login (Discord Oauth2 support) is a premium feature, only available to [Patrons](https://patreon.com/kyber).\n\n## Contributing\n\nIf you can make improvements in the design and presentation of logs, please make a pull request with changes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimide%2Flogviewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimide%2Flogviewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimide%2Flogviewer/lists"}