{"id":19988022,"url":"https://github.com/getredash/setup","last_synced_at":"2025-04-07T08:14:38.317Z","repository":{"id":41451505,"uuid":"153594339","full_name":"getredash/setup","owner":"getredash","description":"Setup scripts for Redash Cloud Images","archived":false,"fork":false,"pushed_at":"2024-09-30T06:29:30.000Z","size":75,"stargazers_count":321,"open_issues_count":7,"forks_count":388,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-31T07:01:54.539Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getredash.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":"2018-10-18T08:59:46.000Z","updated_at":"2025-03-27T12:26:39.000Z","dependencies_parsed_at":"2023-02-09T20:05:12.997Z","dependency_job_id":"de4dc252-64ec-437e-9950-1e11b44110b0","html_url":"https://github.com/getredash/setup","commit_stats":{"total_commits":53,"total_committers":8,"mean_commits":6.625,"dds":0.5283018867924528,"last_synced_commit":"96e4f16e70ab9fa354e7333ff8e03eb06337027c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getredash%2Fsetup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getredash%2Fsetup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getredash%2Fsetup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getredash%2Fsetup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getredash","download_url":"https://codeload.github.com/getredash/setup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247615377,"owners_count":20967184,"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-13T04:40:50.691Z","updated_at":"2025-04-07T08:14:38.295Z","avatar_url":"https://github.com/getredash.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup script for Redash with Docker on Linux\n\nThis is a reference setup for Redash on a single Linux server.\n\nIt uses Docker and Docker Compose for deployment and management.\n\nThis is the same setup we use for our official images (for AWS \u0026 Google Cloud) and can be used as reference if you want\nto manually setup Redash in a different environment (different OS or different deployment location).\n\n- `setup.sh` is the script that installs everything and creates the directories.\n- `compose.yaml` is the Docker Compose setup we use.\n- `packer.json` is Packer configuration we use to create the Cloud images.\n\n## Tested\n\n- Alma Linux 8.x \u0026 9.x\n- CentOS Stream 9.x\n- Debian 12.x\n- Fedora 38, 39 \u0026 40\n- Oracle Linux 9.x\n- Red Hat Enterprise Linux 8.x \u0026 9.x\n- Rocky Linux 8.x \u0026 9.x\n- Ubuntu LTS 20.04 \u0026 22.04\n\n## How to use this\n\nThis script should be run as the `root` user on a supported Linux system (as per above list):\n\n```\n# ./setup.sh\n```\n\nWhen run, the script will install the needed packages (mostly Docker) then install Redash, ready for you to configure\nand begin using.\n\n\u003e [!TIP]\n\u003e If you are not on a supported Linux system, you can manually install 'docker' and 'docker compose',  \n\u003e then run the script to start the Redash installation process.\n\n\u003e [!IMPORTANT]\n\u003e The very first time you load your Redash web interface it can take a while to appear, as the background Python code\n\u003e is being compiled.  On subsequent visits, the pages should load much quicker (near instantly).\n\n## Optional parameters\n\nThe setup script has three optional parameters, `--dont-start`, `--preview` and `--overwrite`.\n\nThese can be used independently of each other, or with each other in any combination.\n\n### --preview\n\nWhen the `--preview` parameter is given, the setup script will install the latest `preview`\n[image from Docker Hub](https://hub.docker.com/r/redash/redash/tags) instead of using the last official release.\n\n```\n# ./setup.sh --preview\n```\n\n### --overwrite\n\n\u003e [!CAUTION]\n\u003e ***DO NOT*** use this parameter if you want to keep your existing Redash installation!  It ***WILL*** be overwritten.\n\nWhen the `--overwrite` option is given, the setup script will delete the existing Redash environment file\n(`/opt/redash/env`) and Redash database, then set up a brand new (empty) Redash installation.\n\n```\n# ./setup.sh --overwrite\n```\n\n### --dont-start\n\nWhen this option is given, the setup script will install Redash without starting it afterwards.\n\nThis is useful for people wanting to customise or modify their Redash installation before it starts for the first time.\n\n```\n# ./setup.sh --dont-start\n```\n\n## FAQ\n\n### Can I use this in production?\n\nFor small scale deployments -- yes. But for larger deployments we recommend at least splitting the database (and\nprobably Redis) into its own server (preferably a managed service like RDS) and setting up at least 2 servers for\nRedash for redundancy. You will also need to tweak the number of workers based on your usage patterns.\n\n### How do I upgrade to newer versions of Redash?\n\nSee [Upgrade Guide](https://redash.io/help/open-source/admin-guide/how-to-upgrade).\n\n### How do I use `setup.sh` on a different operating system?\n\nYou will need to create a docker installation function that suits your operating system, and maybe other functions as\nwell.\n\nThe `install_docker_*()` functions in setup.sh shouldn't be too hard to adapt to other Linux distributions.\n\n### How do I remove Redash if I no longer need it?\n\n1. Stop the Redash containers and remove the images using `docker compose -f /opt/redash/compose.yaml down --volumes --rmi all`.\n2. Remove the following lines from `~/.profile` and `~/.bashrc` if they're present.\n\n   ```\n   export COMPOSE_PROJECT_NAME=redash\n   export COMPOSE_FILE=/opt/redash/compose.yaml\n   ```\n\n3. Delete the Redash folder using `sudo rm -fr /opt/redash`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetredash%2Fsetup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetredash%2Fsetup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetredash%2Fsetup/lists"}