{"id":29020387,"url":"https://github.com/appbaseio/reactivesearch-api-docker","last_synced_at":"2025-06-26T01:05:32.154Z","repository":{"id":41098216,"uuid":"219845370","full_name":"appbaseio/reactivesearch-api-docker","owner":"appbaseio","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-03T19:33:26.000Z","size":95,"stargazers_count":9,"open_issues_count":3,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-03T20:30:38.333Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/appbaseio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-11-05T20:34:33.000Z","updated_at":"2025-02-03T19:33:32.000Z","dependencies_parsed_at":"2024-07-19T18:14:19.090Z","dependency_job_id":"d6d997ba-bbef-42ad-8d69-24bd4de6000d","html_url":"https://github.com/appbaseio/reactivesearch-api-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/appbaseio/reactivesearch-api-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-api-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-api-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-api-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-api-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appbaseio","download_url":"https://codeload.github.com/appbaseio/reactivesearch-api-docker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appbaseio%2Freactivesearch-api-docker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261978910,"owners_count":23239417,"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":"2025-06-26T01:05:30.510Z","updated_at":"2025-06-26T01:05:32.111Z","avatar_url":"https://github.com/appbaseio.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReactiveSearch.io: Dockerize Setup\n\nThis setup enables you to run [ReactiveSearch API server](https://reactivesearch.io/) with single command, i.e. `docker-compose up -d` 😎.\n\nThe docker-compose setup in this repository comes with four different services:\n\n#### reactivesearch-api\n\n`reactivesearch-api` is an opensource image providing a declarative API to query Elasticsearch, and is required by ReactiveSearch and Searchbox UI libraries. You can check out the source code over [here](https://github.com/appbaseio/reactivesearch-api).\n\nIt is also available as a licensed image.\n\n\u003e **Note:** Make sure your rs-api container has super user access to Elasticsearch. You can secure Elasticsearch URL with Basic Auth or set an IP based restriction.\n\n#### nginx\n\nThis service helps in setting up reverse proxy for Arc Service and serving Configuration service. It also helps in serving data using with TLS certificate, which is recommended for production.\n\n#### elasticsearch\n\nThe Elasticsearch service allows spinning up an Elasticsearch server instance locally. This is optional, however running this service allows for an end-to-end ReactiveSearch service setup.\n\n#### opensearch\n\nThe OpenSearch service allows spinning up an OpenSearch server instance locally. This is an alteroptional, however running this service allows for an end-to-end ReactiveSearch service setup.\n\n\n| file                                                     | Use Case                                                                                                                                                       |\n|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| docker-compose-oss-with-elasticsearch-without-nginx.yaml | Run the open-source ReactiveSearch API server with Elasticsearch, but without Nginx and ReactiveSearch's config GUI.                                           |\n| docker-compose-oss-with-elasticsearch.yaml               | Run the open-source ReactiveSearch API server with Elasticsearch, Nginx and ReactiveSearch's config GUI.                                                       |\n| docker-compose-oss.yaml                                  | Run the open-source ReactiveSearch API server with Nginx and ReactiveSearch's config GUI, but without Elasticsearch (i.e. it's assumed to be hosted in cloud). |\n| docker-compose-with-elasticsearch-without-nginx.yaml     | Run the licensed ReactiveSearch API server with Elasticsearch, but without Nginx and ReactiveSearch's config GUI.                                              |\n| docker-compose-with-elasticsearch.yaml                   | Run the licensed ReactiveSearch API server with Elasticsearch, Nginx and ReactiveSearch's config GUI.                                                          |\n| docker-compose.yaml                                      | Run the licensed ReactiveSearch API server with Nginx and ReactiveSearch's config GUI, but without Elasticsearch (i.e. it's assumed to be hosted in cloud).    |\n| docker-compose-oss-with-opensearch.yaml               | Run the open-source ReactiveSearch API server with OpenSearch, and Nginx.                     |\n| docker-compose-with-opensearch.yaml               | Run the open-source ReactiveSearch API server with OpenSearch, Nginx and ReactiveSearch's config GUI.                                                       |\n\nTo run one of the above presets, use the following command:\n\n`docker-compose -f ${file} up -d`\n\nSimilarly, `docker-compose -f ${file} down` will delete \n\nwhere `${file}` is one of the above values.\n\n## Quick Start 🚀\n\nThe steps described here assumes a [docker](https://docs.docker.com/install/) installation on the system.\n\n- **Step 1:** Get APPBASE_ID following the steps mentioned [here](https://docs.reactivesearch.io/docs/hosting/BYOC/#using-ami)\n\n\u003e Note: Skip this step when running in an open-source mode\n\n- **Step 2:** Clone the repository\n\n  ```bash\n  git clone https://github.com/appbaseio/reactivesearch-api-docker.git \u0026\u0026 cd reactivesearch-api-docker\n  ```\n\n- **Step 3:** Configure logging system\n\n  ReactiveSearch API uses [Fluentbit](https://fluentbit.io/) to log the requests and provide analytics on top of that. In order to setup fluentbit, update `fluent-bit.conf` with Elasticsearch `Host`, `Port`, `tls`, `HTTP_User` and `HTTP_Passwd` information.\n\n  ![](https://www.dropbox.com/s/ucaj3gtdj331j9v/Screenshot%202020-07-01%2011.49.34.png?raw=1)\n\n  \u003e **Note:** If you are using `docker-compose-with-elasticsearch.yaml` then you don't need to change any configurations in here.\n\n* **Step 4:** Build and run docker containers\n\n  We highly recommend using ReactiveSearch API with [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) so that we can easily bind this with ReactiveSearch Dashboard. To simplify the process of docker build, test and deployment we have created 2 versions:\n\n  1 - **Install ReactiveSearch API + Nginx with TLS setup _(Recommended for production)_**\n\n  - Change [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) certificate and keys with production files. Please obtain [TLS](https://en.wikipedia.org/wiki/Transport_Layer_Security) certificate and key for your domain using [Let's Encrypt](https://letsencrypt.org/) or any other provider. Update the files in [nginx/certs](https://github.com/appbaseio/arc-dockerized/tree/master/nginx/certs)\n  - In case you are using different name then mentioned in [nginx/certs](https://github.com/appbaseio/arc-dockerized/tree/master/nginx/certs) folder, then please update them in `docker-compose.yaml` file as well\n\n  ![](https://i.imgur.com/piUKTLl.png)\n\n  Also, make sure you update file names in [nginx/default.conf](https://github.com/appbaseio/arc-dockerized/blob/master/nginx/default.conf) file\n\n  ![](https://i.imgur.com/LW8zOyB.png)\n\n  ```bash\n  docker-compose up -d\n  ```\n\n  2 - **Install ReactiveSearch API + Elasticsearch _(If you want to deploy ReactiveSearch API Along with Elasticsearch.)_**\n\n  ```\n  docker-compose -f docker-compose-with-elasticsearch.yaml up -d\n  ```\n\n  🔥 Thats all, our containers should be up and running. Next let us configure environment variables required by Arc service.\n\n* **Step 5:** Open configuration service URL in your browser, i.e. [http://localhost](http://localhost)\n\n  \u003e **Note:** If you are running this setup on an virtual machine, make sure ports `80` and `443` are set in your inbound rules for the cluster.\n\n* **Step 6:** Set credentials\n\n* **Step 7:** Configure Elasticsearch URL and APPBASE_ID obtained above.\n\n  \u003e **Note:** Once you save the configuration, it may take 5-10s to restart the reactivesearch-api service.\n\n* **Step 8:** Start using ReactiveSearch API using [ReactiveSearch Dashboard](https://dashboard.reactivesearch.io/). Here you will have to input Arc Cluster URL which will be [http://localhost](http://localhost) and credentials would be the one that you configured initially on **Step 5**.\n\n## Configuring TLS for development\n\nWe recommend configuring TLS using the excellent [`mkcert`](https://github.com/FiloSottile/mkcert) utility. Once installed on your local system:\n\n```bash\nmkcert -key-file=nginx/certs/server.key -cert-file=nginx/certs/server.crt reactivesearch.dev localhost\n```\n\nThis will save the cert key and pem files into paths that are used by the nginx service in the `docker-compose-with-elasticsearch.yaml` file.\n\nOnce the certs are configured, start the service with:\n\n```bash\ndocker-compose -f docker-compose-with-elasticsearch.yaml up -d\n```\n\nYou can now visit: https://localhost to get a TLS domain. For https://reactivesearch.dev to point to reactivesearch.io service, add the entry:\n\n```\n127.0.0.1    reactivesearch.dev\n```\n\nin your `/etc/hosts` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Freactivesearch-api-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappbaseio%2Freactivesearch-api-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappbaseio%2Freactivesearch-api-docker/lists"}