{"id":15288016,"url":"https://github.com/exshome/exshome","last_synced_at":"2025-06-15T20:43:11.682Z","repository":{"id":36957288,"uuid":"436267088","full_name":"exshome/exshome","owner":"exshome","description":"DIY Experimental Elixir-based smart home","archived":false,"fork":false,"pushed_at":"2025-06-02T16:00:01.000Z","size":2022,"stargazers_count":28,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-03T04:44:01.942Z","etag":null,"topics":["elixir","liveview","phoenix"],"latest_commit_sha":null,"homepage":"","language":"Elixir","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/exshome.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2021-12-08T13:59:05.000Z","updated_at":"2025-06-02T15:59:58.000Z","dependencies_parsed_at":"2023-10-02T12:36:53.184Z","dependency_job_id":"58aa0f46-e21a-42da-b1f3-32f05bf625a2","html_url":"https://github.com/exshome/exshome","commit_stats":{"total_commits":609,"total_committers":2,"mean_commits":304.5,"dds":0.06239737274220036,"last_synced_commit":"d59fb44b94fd378b779361f8c3fc1f95ca97925e"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/exshome/exshome","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exshome%2Fexshome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exshome%2Fexshome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exshome%2Fexshome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exshome%2Fexshome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/exshome","download_url":"https://codeload.github.com/exshome/exshome/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/exshome%2Fexshome/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260046827,"owners_count":22950907,"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":["elixir","liveview","phoenix"],"created_at":"2024-09-30T15:43:48.385Z","updated_at":"2025-06-15T20:43:11.644Z","avatar_url":"https://github.com/exshome.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Exshome\n\n[![CI](https://github.com/exshome/exshome/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/exshome/exshome/actions/workflows/ci.yml?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/exshome/exshome/branch/main/graph/badge.svg?token=N0HBNURO8P)](https://codecov.io/gh/exshome/exshome)\n[![Hex Package](https://img.shields.io/hexpm/v/exshome.svg?color=green)](https://hex.pm/packages/exshome)\n[![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/exshome)\n\nDIY Experimental Elixir-based smart home.\n\n## System dependencies\n- [MPV](https://mpv.io/) - Exshome uses it as a player. You will not be able to play any track without it.\n\n## Project goals\n- Mobile-friendly\n- Extensibility\n- Test coverage\n- Should support different Single Board Computers\n- Designed to run in the home network (NAT)\n\n## Getting started with development\n- Install dependencies with `mix deps.get`\n- Setup database `mix ecto.setup`\n- Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`. Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.\n\n### Example pre-commit hook\nYou can use a pre-commit hook to check that CI will not fail on most frequent errors.\nYou will need to put it into `.git/hooks/pre-commit` and make it executable (`chmod +x .git/hooks/pre-commit`).\n\nExample hook:\n```\n#!/bin/bash\n\nMIX_ENV=test mix dialyzer || exit 1\nMIX_ENV=test mix format --check-formatted || exit 1\nMIX_ENV=test mix credo list --strict || exit 1\nMIX_ENV=test mix coveralls --warnings-as-errors || exit 1\n```\n\n## Launching as a script\nYou can use `bin/exshome` to start an application. It is an executable Elixir script. It downloads Exshome and starts the application.\n\nYou can download the latest version here:\n```\nwget https://raw.githubusercontent.com/exshome/exshome/main/bin/exshome\nchmod +x exshome\n./exshome\n```\n\nThis script supports these environment variables:\n- `EXSHOME_VERSION` - Exshome version. You can get the latest available version [at hex.pm](https://hex.pm/packages/exshome)\n- `EXSHOME_HOST` - Host to listnen on, default is \"0.0.0.0\".\n- `EXSHOME_PORT` - Application port, default is \"5000\".\n- `EXSHOME_ROOT` - Path where all application data resides, default is \"${HOME}/.exshome\".\n- `EXSHOME_SIGNING_SALT` - LiveView specific variable. Generates a random value on each launch by default.\n- `EXSHOME_SECRET_KEY_BASE` - Secret key for Phoenix framework. Generates a random value on each launch by default.\n\n## Caveats\n- [UNIX domain socket length is limited to about 100 bytes](https://unix.stackexchange.com/questions/367008/why-is-socket-path-length-limited-to-a-hundred-chars). Application uses these sockets to communicate with MPV. It will not work if the path is larger.\n\n## Applications\n\nExshome includes simple applications. Each application has own pages.\n\n### Clock (ExshomeClock)\nSimple clock.\n\n### Player (ExshomePlayer)\nAllows to play music. You can upload your files or add links to the remote resources.\n\n### Automation (ExshomeAutomation)\nIt is early WIP. Responsible for automating workflows.\n\n## Security considerations\nRight now Exshome is designed to run in a home network, so it has no auth. It can be dangerous to open it for a whole Internet.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexshome%2Fexshome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexshome%2Fexshome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexshome%2Fexshome/lists"}