{"id":18339239,"url":"https://github.com/jeffwilliams/quartz-flow","last_synced_at":"2025-04-06T05:32:01.444Z","repository":{"id":11192542,"uuid":"13573317","full_name":"jeffwilliams/quartz-flow","owner":"jeffwilliams","description":"Web-based torrent client","archived":false,"fork":false,"pushed_at":"2015-05-14T02:54:54.000Z","size":618,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-21T18:07:09.207Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","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/jeffwilliams.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}},"created_at":"2013-10-14T21:08:42.000Z","updated_at":"2017-10-03T05:55:24.000Z","dependencies_parsed_at":"2022-08-31T03:22:56.687Z","dependency_job_id":null,"html_url":"https://github.com/jeffwilliams/quartz-flow","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwilliams%2Fquartz-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwilliams%2Fquartz-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwilliams%2Fquartz-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwilliams%2Fquartz-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeffwilliams","download_url":"https://codeload.github.com/jeffwilliams/quartz-flow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247440392,"owners_count":20939220,"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-05T20:16:56.151Z","updated_at":"2025-04-06T05:32:00.480Z","avatar_url":"https://github.com/jeffwilliams.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"QuartzFlow -- A Web-based Bittorrent Client\n===========================================\n\n[![Gem Version](https://badge.fury.io/rb/quartz_flow.png)](http://badge.fury.io/rb/quartz\\_flow)\n\n\nA Web-based Bittorrent client.\n\nQuartzFlow runs as a standalone application which contains a web-server. For those familiar with ruby, it uses Sinatra\nto run as a webserver.\n\nQuartzFlow requires ruby 1.9 or greater.\n\n\nInstallation\n------------\n\n`gem install quartz_flow`\n\nRunning\n-------\n\n### Quick Start\n\n  1. Make a directory owned by the current user where you want QuartzFlow to run.\n  2. Run `quartzflow setup` to set up the current directory.\n  3. Run `quartzflow adduser --login someone` to add a user named `someone` (replace someone with a good username).\n  4. Run `quartzflow start` or just `quartzflow` to run QuartzFlow.\n  5. Open `localhost:4445/` with your browser and log in.\n  6. When finished use CTRL-C to exit.\n  7. (Optional) Edit `etc/quartz.rb` and change settings if desired. Restart after changes.\n\n### Details\n\nQuartzFlow expects to be run in a special \"home\" directory. This is a regular directory that has\nhad `quartzflow setup` run in it; that is, the command is run with the current directory being the directory to set up.\nThis setup creates the necessary environment needed for QuartzTorrent to run. It creates the required subdirectories,\ncopies the HTML templates, creates an empty settings database, and creates default settings files.\nThis setup only needs to be performed once per home, and from then on QuartzTorrent can\nbe launched from that directory.\n\nA successfully setup QuartzTorrent home directory contains the following:\n\n`etc/`\n\nStatic settings. These are things like what port to listen on, and how to log messages.\n\n`db/`\n\nDynamic settings. Under this directory is a SQLite database used to store settings that can be changed\nthrough the webpage.\n\n`log/`\n\nLogs. By default, logs about torrent downloading and uploading are written here.\n\n`public/, views/`\n\nWeb files. These are the HTML templates, Javascript files, and CSS served when the app is running.\n\n`meta/`\n\nTorrent metainformation. This is where downloaded and uploaded .torrent files are stored, and where Magnet\nlinks are persisted.\n\n`download/`\n\nDownloaded Torrents. By default, downloaded torrent data is written to this directory.\n\nUse the command `quartzflow help` to get help for the various commands.\n\n`plugins/`\n\nActive quartzflow plugins.\n\n### Development Setup\n\nThe development setup does not use the released gem, rather the current git repository.\n\n1.  Clone this repository and cd into it\n3. `bundle` to download neccessary gems\n2. `bundle exec quartzflow setup`, to create neccessary files, they will be ignored by git\n4. `bundle exec quartzflow` to start server\n\nSo basically after the first bundle the instructions are the same, you just need to prefix commands\nwith \"bundle exec\" to use the git versions instead of the gem.\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffwilliams%2Fquartz-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeffwilliams%2Fquartz-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffwilliams%2Fquartz-flow/lists"}