{"id":13775796,"url":"https://github.com/teamhg-memex/aquarium","last_synced_at":"2025-08-21T15:31:49.023Z","repository":{"id":53549964,"uuid":"41330311","full_name":"TeamHG-Memex/aquarium","owner":"TeamHG-Memex","description":"Splash + HAProxy + Docker Compose","archived":false,"fork":false,"pushed_at":"2018-11-29T18:23:23.000Z","size":1203,"stargazers_count":198,"open_issues_count":24,"forks_count":41,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-12-11T21:41:54.549Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/TeamHG-Memex.png","metadata":{"files":{"readme":"README.rst","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":"2015-08-24T22:33:05.000Z","updated_at":"2024-09-25T19:32:04.000Z","dependencies_parsed_at":"2022-08-30T21:52:28.448Z","dependency_job_id":null,"html_url":"https://github.com/TeamHG-Memex/aquarium","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamHG-Memex%2Faquarium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamHG-Memex%2Faquarium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamHG-Memex%2Faquarium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamHG-Memex%2Faquarium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeamHG-Memex","download_url":"https://codeload.github.com/TeamHG-Memex/aquarium/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230520390,"owners_count":18238948,"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-08-03T17:01:50.271Z","updated_at":"2024-12-20T01:15:00.714Z","avatar_url":"https://github.com/TeamHG-Memex.png","language":"Python","funding_links":[],"categories":["\u003ca id=\"d03d494700077f6a65092985c06bf8e8\"\u003e\u003c/a\u003e工具"],"sub_categories":["\u003ca id=\"d3069cac6097830d12f5933c9c8b7a77\"\u003e\u003c/a\u003eHAProxy"],"readme":"Aquarium\n========\n\nAquarium is a cookiecuter_ template for hassle-free\n`Docker Compose`_ + Splash_ setup. Think of it as a Splash instance\nwith extra features and without common pitfalls.\n\n.. _cookiecuter: http://cookiecutter.rtfd.org\n.. _Splash: https://github.com/scrapinghub/splash\n.. _Docker Compose: https://docs.docker.com/compose/\n\nUsage\n-----\n\nFirst, make sure Docker and Docker Compose are installed.\n\nThen install cookiecutter::\n\n    pip install cookiecutter\n\nor (on OS X + homebrew)::\n\n    brew install cookiecutter\n\nThen generate a folder with config files::\n\n    cookiecutter gh:TeamHG-Memex/aquarium\n\nWith all default options it'll create an ``aquarium`` folder in the current\npath. Go to this folder and start the Splash cluster::\n\n    cd ./aquarium\n    docker-compose up\n\nThen use http://\u003chost\u003e:8050 as a regular Splash_ instance. On Linux\nhttp://0.0.0.0:8050 should work; on OS X and Windows IP address depends on\nboot2docker or docker-machine.\n\nOptions\n-------\n\nWhen generating a config, cookiecutter will ask a bunch of questions.\n\n* ``folder_name (default is \"aquarium\")`` - a name of the target folder.\n* ``num_splashes (default is \"3\")`` - a number of Splash instances to create.\n  To utilize full server capacity it makes sense to create slightly more Splash\n  instances than CPU cores - e.g. on 2-core machine 3 instances often\n  work best.\n* ``splash_version (default is \"3.0\")`` - a version of scrapighub/splash\n  Docker image.\n* ``auth_user (default is \"user\")``, ``auth_password (default is \"userpass\")``\n  - HTTP Basic Auth credentials for Splash.\n* ``splash_verbosity (default is \"1\")`` - Splash log verbosity, from 0 to 5.\n* ``max_timeout (default is \"3600\")`` - maximum allowed timeout.\n* ``maxrss_mb (default is \"3000\")`` - a soft memory limit, in MB. Splash\n  container will be restarted after some time if it starts to use more memory\n  then this value.\n* ``splash_slots (default is 5)`` - a number of Splash slots to use, i.e.\n  how many render jobs to run in parallel in a single Splash process.\n* ``stats_enabled (default is \"1\")`` - whether to enable HAProxy stats.\n  If stats are enabled visit http://\u003chost\u003e:8036 to see stats page.\n* ``stats_auth (default is \"admin:adminpass\")`` - HTTP Basic Auth credentials\n  for HAProxy stats.\n* ``tor (default is \"1\")`` - enter 0 to disable Tor_ support. When Tor support\n  is enabled, all .onion links are opened using Tor. In addition to\n  that, there is ``tor`` `Splash proxy profile`_ which you can use to render\n  any page using Tor.\n* ``adblock (default is \"1\")`` - Enter 0 to disable AdBlock Plus\n   `request filters`_ (FIXME: this option is not working yet;\n   filters are always available). By default, the following filters\n   are available:\n\n  * `easylist`: default set of EasyList_ filters for English;\n  * `easyprivacy`: EasyPrivacy filters remove tracking scripts;\n  * `easylist_noadult`: EasyList variant without filters for adult domains;\n  * `fanboy-social`: removes social media content such as the Facebook like\n    buttons and other widgets.\n  * `fanboy-annoyance`: blocks Social Media content, in-page pop-ups\n    and other annoyances; use it to decrease loading times and uncluttering\n    pages. `fanboy-social` is already included in this filter.\n\n.. _Tor: http://torproject.org\n.. _Splash proxy profile: http://splash.readthedocs.org/en/latest/api.html#proxy-profiles\n.. _request filters: http://splash.readthedocs.org/en/latest/api.html#request-filters\n.. _EasyList: https://easylist.to/\n\nContributing\n------------\n\n* Source code: https://github.com/TeamHG-Memex/aquarium\n* Bug tracker: https://github.com/TeamHG-Memex/aquarium/issues\n\nLicense is MIT.\n\n----\n\n.. image:: https://hyperiongray.s3.amazonaws.com/define-hg.svg\n\t:target: https://www.hyperiongray.com/?pk_campaign=github\u0026pk_kwd=aquarium\n\t:alt: define hyperiongray\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamhg-memex%2Faquarium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteamhg-memex%2Faquarium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamhg-memex%2Faquarium/lists"}