{"id":19339174,"url":"https://github.com/retrixe/ecthelion","last_synced_at":"2025-04-23T02:30:33.838Z","repository":{"id":38357698,"uuid":"208610505","full_name":"retrixe/ecthelion","owner":"retrixe","description":"A frontend for Octyne for remote administration.","archived":false,"fork":false,"pushed_at":"2025-03-31T18:04:19.000Z","size":1728,"stargazers_count":3,"open_issues_count":9,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T06:22:32.703Z","etag":null,"topics":["eslint","frontend","material-ui","nextjs","octyne","react","react-window","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/retrixe.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-09-15T14:59:36.000Z","updated_at":"2025-02-27T14:34:25.000Z","dependencies_parsed_at":"2024-01-22T21:55:21.576Z","dependency_job_id":"9fc01509-5272-4778-a689-3438abb87d9b","html_url":"https://github.com/retrixe/ecthelion","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fecthelion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fecthelion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fecthelion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retrixe%2Fecthelion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/retrixe","download_url":"https://codeload.github.com/retrixe/ecthelion/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250357506,"owners_count":21417288,"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":["eslint","frontend","material-ui","nextjs","octyne","react","react-window","typescript"],"created_at":"2024-11-10T03:20:19.391Z","updated_at":"2025-04-23T02:30:33.818Z","avatar_url":"https://github.com/retrixe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ecthelion\n\nA frontend for Octyne.\n\n## Quick Start\n\n1. Prerequisites: Install [Node.js](https://nodejs.dev/en/download/) and [Git](https://www.atlassian.com/git/tutorials/install-git). Run `corepack enable` in the terminal as admin/`sudo` to install the Yarn package manager.\n2. Download Ecthelion to a folder by running `git clone https://github.com/retrixe/ecthelion.git` in terminal where you wish to place Ecthelion.\n3. Select the current version of Ecthelion after downloading it by running `git checkout \u003cversion\u003e` in the Ecthelion folder. Alternatively, for the development version, run `git checkout main`.\n4. Follow the steps [here](https://github.com/retrixe/ecthelion#configuration) to configure Ecthelion correctly. After configuration changes, rebuild Ecthelion with `yarn \u0026\u0026 yarn build`.\n5. Run `yarn start` to start Ecthelion's built-in web server, you can specify a port by passing `-p \u003cport\u003e`. Alternatively, you can run `yarn export` to export Ecthelion to static HTML/CSS/JS files in the `out` folder you can serve via nginx or Apache, however, supporting dynamic routes will require additional work.\n6. To update Ecthelion in the future, run `git pull`, then re-run step 3 through 5.\n\nYou might want to manage Ecthelion using systemd on Linux systems, which can start and stop Ecthelion, start it on boot, store its logs and restart it on crash. [This article should help you out.](https://medium.com/@benmorel/creating-a-linux-service-with-systemd-611b5c8b91d6) Alternatively, you can run Ecthelion with Octyne, but if you have issues with Ecthelion, this may be a problem.\n\n## Configuration\n\nCreate a `config.json` in the top level of the project and then add the following content:\n\n```json\n{\n  \"ip\": \"\u003cabsolute URL to Octyne\u003e\",\n  \"nodes\": {\n    \"\u003cname of node\u003e\": \"\u003cabsolute URL to Octyne node\u003e\"\n  },\n  \"basePath\": \"\u003cpass this if you want ecthelion on a sub-path like e.g. /ecthelion\u003e\",\n  \"enableCookieAuth\": false\n}\n```\n\n**⚠️ Important Notes:**\n\n- The `ip` field is required, while `nodes`, `basePath` and `enableCookieAuth` are optional.\n- Absolute URLs to Octyne should be accessible to users (make sure Octyne is port forwarded), and are in the format of `http[s]://\u003cip address or domain name\u003e[:\u003cport\u003e][/\u003csub-URL if using nginx/apache to reverse proxy\u003e]`, e.g. `http://43.12.45.32:42069` or `https://console.myserver.com/octyne`. The URL should also not end with `/`!\n- Cookie authentication is more secure, but it requires Octyne v1.1+, and Ecthelion + all Octyne nodes must be under 1 domain or IP address! For this, you can use a reverse proxy like nginx or Apache, [the Octyne documentation has sample configs for both software](https://github.com/retrixe/octyne#security-practices-and-reverse-proxying) to achieve this.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretrixe%2Fecthelion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fretrixe%2Fecthelion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretrixe%2Fecthelion/lists"}