{"id":13540928,"url":"https://github.com/dat-ecosystem-archive/hypercloud","last_synced_at":"2025-04-02T08:30:52.352Z","repository":{"id":45143560,"uuid":"68567697","full_name":"dat-ecosystem-archive/hypercloud","owner":"dat-ecosystem-archive","description":"A hosting server for Dat.                               [ DEPRECATED - see github.com/beakerbrowser/hashbase for similar functionality. More info on active projects and modules at https://dat-ecosystem.org/ ]","archived":true,"fork":false,"pushed_at":"2022-01-06T02:10:14.000Z","size":401,"stargazers_count":97,"open_issues_count":21,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-06T22:02:45.297Z","etag":null,"topics":["dat","p2p","server"],"latest_commit_sha":null,"homepage":"https://github.com/beakerbrowser/hashbase","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dat-ecosystem-archive.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-19T03:57:36.000Z","updated_at":"2023-09-08T17:14:58.000Z","dependencies_parsed_at":"2022-07-21T06:18:29.753Z","dependency_job_id":null,"html_url":"https://github.com/dat-ecosystem-archive/hypercloud","commit_stats":null,"previous_names":["datprotocol/hypercloud","dat-land/hypercloud"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dat-ecosystem-archive%2Fhypercloud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dat-ecosystem-archive%2Fhypercloud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dat-ecosystem-archive%2Fhypercloud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dat-ecosystem-archive%2Fhypercloud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dat-ecosystem-archive","download_url":"https://codeload.github.com/dat-ecosystem-archive/hypercloud/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246781866,"owners_count":20832923,"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":["dat","p2p","server"],"created_at":"2024-08-01T10:00:36.180Z","updated_at":"2025-04-02T08:30:51.996Z","avatar_url":"https://github.com/dat-ecosystem-archive.png","language":"JavaScript","readme":"[![deprecated](http://badges.github.io/stability-badges/dist/deprecated.svg)](github.com/beakerbrowser/hashbase) See [hashbase](github.com/beakerbrowser/hashbase) for similar functionality. \n\nMore info on active projects and modules at [dat-ecosystem.org](https://dat-ecosystem.org/) \u003cimg src=\"https://i.imgur.com/qZWlO1y.jpg\" width=\"30\" height=\"30\" /\u003e \n\n---\n\n# Hypercloud ☁ \n\nHypercloud is a public peer service for [Dat](https://datproject.org) archives. It provides a HTTP-accessible interface for creating an account and uploading Dats.\n\nFeatures:\n\n - Simple Dat uploading and hosting\n - Easy to replicate Dats, Users, or entire datasets between Hypercloud deployments\n - Configurable user management\n - Easy to self-deploy\n\nLinks:\n\n - **[Get Involved](https://github.com/joehand/hypercloud/wiki)**\n - **[Documentation](./docs)**\n\n## Setup\n\nClone this repository, then run\n\n```\nnpm install\ncp config.defaults.yml config.development.yml\n```\n\nModify `config.development.yml` to fit your needs, then start the server with `npm start`.\n\n## Configuration\n\nBefore deploying the service, you absolutely *must* modify the following config.\n\n#### Basics\n\n```yaml\ndir: ./.hypercloud            # where to store the data\nbrandname: Hypercloud         # the title of your service\nhostname: hypercloud.local    # the hostname of your service\nport: 8080                    # the port to run the service on\nrateLimiting: true            # rate limit the HTTP requests?\ndefaultDiskUsageLimit: 100mb  # default maximum disk usage for each user\npm2: false                    # set to true if you're using https://keymetrics.io/\n```\n\n#### Lets Encrypt\n\nYou can enable lets-encrypt to automatically provision TLS certs using this config:\n\n```yaml\nletsencrypt:\n  debug: false          # debug mode? must be set to 'false' to use live config\n  email: 'foo@bar.com'  # email to register domains under\n```\n\nIf enabled, `port` will be ignored and the server will register at ports 80 and 443.\n\n#### Admin Account\n\nThe admin user has its credentials set by the config yaml at load. If you change the password while the server is running, then restart the server, the password will be reset to whatever is in the config.\n\n```yaml\nadmin:\n  email: 'foo@bar.com'\n  password: myverysecretpassword\n```\n\n#### UI Module\n\nThe frontend can be replaced with a custom npm module. The default is [hypercloud-ui-vanilla](https://npm.im/hypercloud-ui-vanilla).\n\n```yaml\nui: hypercloud-ui-vanilla\n```\n\n#### HTTP Sites\n\nHypercloud can host the archives as HTTP sites. This has the added benefit of enabling [dat-dns shortnames](npm.im/dat-dns) for the archives. There are two possible schemes:\n\n```yaml\nsites: per-user\n```\n\nPer-user will host archives at `username.hostname/archivename`, in a scheme similar to GitHub Pages. If the archive-name is == to the username, it will be hosted at `username.hostname`.\n\nNote that, in this scheme, a DNS shortname is only provided for the user archive (`username.hostname`).\n\n```yaml\nsites: per-archive\n```\n\nPer-archive will host archives at `archivename-username.hostname`. If the archive-name is == to the username, it will be hosted at `username.hostname`.\n\nBy default, HTTP Sites are disabled.\n\n#### Closed Registration\n\nFor a private instance, use closed registration with a whitelist of allowed emails:\n\n```yaml\nregistration:\n  open: false\n  allowed:\n    - alice@mail.com\n    - bob@mail.com\n```\n\n#### Reserved Usernames\n\nUse reserved usernames to blacklist usernames which collide with frontend routes, or which might be used maliciously.\n\n```yaml\nregistration:\n  reservedNames:\n    - admin\n    - root\n    - support\n    - noreply\n    - users\n    - archives\n```\n\n#### Session Tokens\n\nHypercloud uses Json Web Tokens to manage sessions. You absolutely *must* replace the `secret` with a random string before deployment.\n\n```yaml\nsessions:\n  algorithm: HS256                # probably dont update this\n  secret: THIS MUST BE REPLACED!  # put something random here\n  expiresIn: 1h                   # how long do sessions live?\n```\n\n#### Jobs\n\nHypercloud runs some jobs periodically. You can configure how frequently they run.\n\n```yaml\n# processing jobs\njobs:\n  popularArchivesIndex: 30s  # compute the index of archives sorted by num peers\n  userDiskUsage: 5m          # compute how much disk space each user is using\n  deleteDeadArchives: 5m     # delete removed archives from disk\n```\n\n#### Emailer\n\n*Todo, sorry*\n\n## Tests\n\nRun the tests with\n\n```\nnpm test\n```\n\nTo run the tests against a running server, specify the env var:\n\n```\nREMOTE_URL=http://{hostname}/ npm test\n```\n\n## License\n\nMIT\n","funding_links":[],"categories":["Using Dat","JavaScript","server"],"sub_categories":["Hosting \u0026 Dat Management"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdat-ecosystem-archive%2Fhypercloud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdat-ecosystem-archive%2Fhypercloud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdat-ecosystem-archive%2Fhypercloud/lists"}