{"id":16216857,"url":"https://github.com/adamcharnock/factorio-status-ui","last_synced_at":"2025-03-19T10:30:38.737Z","repository":{"id":54295825,"uuid":"111246394","full_name":"adamcharnock/factorio-status-ui","owner":"adamcharnock","description":"Status web interface for your factorio dedicated server. View users \u0026 download mods","archived":false,"fork":false,"pushed_at":"2022-09-15T22:22:41.000Z","size":1442,"stargazers_count":11,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-28T17:51:06.840Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adamcharnock.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.txt","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-18T23:01:02.000Z","updated_at":"2025-01-03T18:49:36.000Z","dependencies_parsed_at":"2023-01-18T09:30:45.586Z","dependency_job_id":null,"html_url":"https://github.com/adamcharnock/factorio-status-ui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcharnock%2Ffactorio-status-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcharnock%2Ffactorio-status-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcharnock%2Ffactorio-status-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamcharnock%2Ffactorio-status-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamcharnock","download_url":"https://codeload.github.com/adamcharnock/factorio-status-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243982177,"owners_count":20378604,"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":[],"created_at":"2024-10-10T11:22:57.908Z","updated_at":"2025-03-19T10:30:38.325Z","avatar_url":"https://github.com/adamcharnock.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Factorio Status Interface\n=========================\n\nProvides a public-facing interface for your factorio server. Information displayed:\n\n* How to connect\n* Mods (with 'download all' option)\n* Players (online \u0026 offline)\n* Server configuration\n* Mod settings\n\n.. image:: https://github.com/adamcharnock/factorio-status-ui/raw/master/docs/screenshot.png\n\nGetting started\n---------------\n\nFactorio Status UI can be run in several ways, so choose the way which best suits you.\n\nPython package\n~~~~~~~~~~~~~~\n\nIf you have Python 3.6 available you can use::\n\n    pip install factorio-status-ui\n    factorio_status_ui \\\n        --mods-directory=\"/path/to/factorio/mods\" \\\n        --saves-directory=\"/path/to/factorio/saves\" \\\n        --rcon-host=127.0.0.1 \\\n        --rcon-port=27015 \\\n        --rcon-password=c14ed7d6e6920dad\n\nDocker image\n~~~~~~~~~~~~\n\nFactorio Status UI is also available as a `docker image`_::\n\n    docker run \\\n        -v /path/to/factorio/mods:/mods \\\n        -v /path/to/factorio/saves:/saves \\\n        -p 8080:8080 \\\n        adamcharnock/factorio-status-ui \\\n        --rcon-host=FACTORIO_SERVER_IP \\\n        --rcon-port=27015 \\\n        --mods-directory=/mods \\\n        --saves-directory=/saves \\\n        --rcon-password=7b548251be2314ff\n\nKubernetes Helm Chart (UI only)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can install Factorio Status UI to your kubernetes cluster via Helm.\nNote that this will require your factorio server to use a form of persistent storage\nwhich can be mounted multiple times (e.g. ``hostDir``, ``nfs`` etc)::\n\n    git clone https://github.com/adamcharnock/factorio-status-ui.git\n    cd factorio-status-ui/deploy/charts/factorio-status-ui\n\n    helm install . \\\n        --set factorio.port=31564 \\\n        --set factorio.rconHost=FACTORIO_RCON_SERVICE_DNS_NAME \\\n        --set factorio.rconPassword=RCON_PASSWORD \\\n        --set persistance.modsPersistantVolumeClaimName=MODS_PVC_NAME \\\n        --set persistance.savesPersistantVolumeClaimName=SAVES_PVC_NAME \\\n        --set factorio.serverName=\"Adam's Factorio Server\" \\\n        --set ingress.enabled=true \\\n        --set ingress.hosts={a.factorio.theihop.com}\n\nIf you want HTTP support (and have kube-lego_ running), then you can add the following::\n\n        --set ingress.tls[0].hosts={a.factorio.theihop.com} \\\n        --set ingress.tls[0].secretName=factorio-tls \\\n\nKubernetes Helm Chart (Factorio + UI only)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTBA - a chart which will install factorio and the status UI in a single kubernetes POD.\nThis will provide a simpler deployment option.\n\nCredits\n-------\n\nDeveloped by Adam Charnock. I'm available for freelance work.\n\nfactorio-status-ui is packaged using seed_.\n\n.. _seed: https://github.com/adamcharnock/seed/\n.. _kube-lego: https://github.com/jetstack/kube-lego\n.. _docker image: https://hub.docker.com/r/adamcharnock/factorio-status-ui/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamcharnock%2Ffactorio-status-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamcharnock%2Ffactorio-status-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamcharnock%2Ffactorio-status-ui/lists"}