{"id":21995090,"url":"https://github.com/redhataccess/eyebrowse","last_synced_at":"2026-05-07T01:36:38.136Z","repository":{"id":54442676,"uuid":"331112776","full_name":"redhataccess/eyebrowse","owner":"redhataccess","description":null,"archived":false,"fork":false,"pushed_at":"2021-02-18T14:06:55.000Z","size":3470,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-24T05:17:51.920Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/redhataccess.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-19T21:21:50.000Z","updated_at":"2022-07-25T19:06:44.000Z","dependencies_parsed_at":"2022-08-13T15:50:26.731Z","dependency_job_id":null,"html_url":"https://github.com/redhataccess/eyebrowse","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/redhataccess/eyebrowse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhataccess%2Feyebrowse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhataccess%2Feyebrowse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhataccess%2Feyebrowse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhataccess%2Feyebrowse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redhataccess","download_url":"https://codeload.github.com/redhataccess/eyebrowse/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhataccess%2Feyebrowse/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261987677,"owners_count":23240890,"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-11-29T21:12:18.168Z","updated_at":"2026-05-07T01:36:33.106Z","avatar_url":"https://github.com/redhataccess.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Eyebrowse\n=========\n\nA prototype S3 bucket file browser.\n\nEyebrowse reads the contents of an S3 bucket, caches the file list locally in mongodb, and provides a simple UI for browsing and downloading the files.\n\n## Prerequisites\n\nNodejs and Mongodb.\n\n## Launching\n\nStart the server.\n```\nnpm install\n\n# for production\nnpm start\n\n# for development\nnpm run dev\n```\n\nBuild and launch the client.\n\n```\ncd client\nnpm install\nnpm start\n```\n\n## Configuration\n\nThe Eyebrowse server is configured with environment variables and the client is configured with a `config.json` file.\n\n### Configuring the server\n\nEyebrowse is configured with the following environment variables.\n\n - `EYEBROWSE_COOKIE_SECRET` - A long, random string used for generating user session cookies.  Allows sessions to persist between restarts of Eyebrowse.  Generate a value with `openssl rand -hex 32` and read more in [Keystone's docs](https://www.keystonejs.com/guides/production/#cookie-secret).\n\n - `EYEBROWSE_S3_REGION` - The S3 region. Default: none.\n - `EYEBROWSE_S3_BUCKET_NAME` - The name of your bucket. Default none.\n - `EYEBROWSE_S3_ACCESS_KEY` - Your access key. Default none.\n - `EYEBROWSE_S3_SECRET_ACCESS_KEY` - Your secret access key. Default none.\n\n - `EYEBROWSE_MONGO_HOST` - The hostname of your mongodb instance. Default `\"localhost\"`\n - `EYEBROWSE_MONGO_PORT` - The port of your mongodb instance. Default `27017`\n - `EYEBROWSE_MONGO_DATABASE` - The database to use.  Default: `\"eyebrowse\"`\n - `EYEBROWSE_MONGO_USER` - The mongodb user.  Default: none.\n - `EYEBROWSE_MONGO_PASSWORD` - The user's password to use.  Default: none.\n\n - `EYEBROWSE_DISPLAY_HIDDEN` - Whether or not to display files whose names begin with `.`, such as `.htaccess`.  Enable with `EYEBROWSE_DISPLAY_HIDDEN=true`, all other values are considered `false`.  Default: `false`.\n\nThese environment variables can be set as normal, _or_ placed into a `.env` file at the root of the project.  The latter is a better option for local development than production.\n\n### Configuring the client\n\nThe client has a single configuration option, `api_url`, which is the URL to the Eyebrowse API.\n\nDefault *config.json*\n```json\n{\n    \"api_url\": \"http://localhost:3000\"\n}\n```\n\nIf the API and client are being served under the same hostname, a host-relative `api_url` can be used, such as:\n\n```json\n    \"api_url\": \"/\"\n```\n\n\nTo improve performance, you can avoid the round-trip fetch of config.json by embedding the configuration within index.html.\n\n## Symlinking\n\nS3 doesn't have a concept of linking, so Eyebrowse simulates symlinks with the following scheme.  If you wish to have a symlink named `latest` that links to the latest version artifact directory `build/artifacts/v2.0.0`, \n\nFilename: _link__latest_\n```\nbuild/artifacts/v2.0.0\n```\n\nThe `link__` name prefix indicates to Eyebrowse that this file is intended to be a symlink.  The file contains the path to the link target.\n\nHere's more clarification about the link behavior.\n\n - Link filename must begin with `link__`\n - Link must be a text file\n - The first line of the text file must be the path to the desired link target\n - The link target may be a file or a directory\n - The path must be absolute (or if you prefer, relative to the root of the bucket)\n - The path must not begin with a slash\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhataccess%2Feyebrowse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredhataccess%2Feyebrowse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhataccess%2Feyebrowse/lists"}