Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

600 add browser usage for the docker image #601

Merged
merged 2 commits into from
Mar 29, 2024

Conversation

dudizimber
Copy link
Contributor

@dudizimber dudizimber commented Mar 28, 2024

fix #600 #599

Summary by CodeRabbit

  • New Features
    • Added instructions for using FalkorDB's browser-based interface.
    • Enabled access to FalkorDB's browser interface via Docker.

@dudizimber dudizimber added the documentation Improvements or additions to documentation label Mar 28, 2024
@dudizimber dudizimber self-assigned this Mar 28, 2024
@dudizimber dudizimber linked an issue Mar 28, 2024 that may be closed by this pull request
Copy link

coderabbitai bot commented Mar 28, 2024

Walkthrough

This update introduces a user-friendly way to deploy and access FalkorDB through a browser-based interface using Docker. It simplifies the setup process, allowing users to quickly start the FalkorDB server and access it via a web interface, enhancing the ease of use and accessibility of FalkorDB.

Changes

Files Change Summary
README.md Added instructions for accessing FalkorDB via a browser using Docker.
build/docker/run.sh Set HOSTNAME to "0.0.0.0" for FalkorDB server accessibility in Docker setup.

Possibly related issues

  • Create a docker container for FalkorDB-browser falkordb-browser#74: This issue calls for the creation of a Docker container for the FalkorDB-browser to simplify deployment. The changes in this PR directly address the objectives by providing clear instructions and ensuring the FalkorDB-browser can be easily deployed and accessed through a Docker container. The setup automation and standardized environment objectives are met with the modifications to the Docker setup and README instructions.

Poem

In the digital meadow, under the byte-sized moon,
A rabbit hopped, with a Docker tune.
"To the browser, to the browser!" it cheerfully cried,
With FalkorDB sailing smoothly by its side.
🐰🌙📦✨
"No more manual setups, no more fuss,
Just a hop, a click, and join us on the bus."

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8b6e630 and 67d7423.
Files selected for processing (2)
  • README.md (1 hunks)
  • build/docker/run.sh (1 hunks)
Additional comments (1)
build/docker/run.sh (1)
  • 7-7: Setting HOSTNAME to "0.0.0.0" allows the FalkorDB server to be accessible from other machines, which aligns with the PR's objective to make FalkorDB accessible via a browser interface. Ensure that this configuration does not unintentionally expose the server to untrusted networks, considering the security implications.

Comment on lines 4 to 10
then
if [ -d /FalkorDBBrowser ]
then
cd /FalkorDBBrowser && node server.js &
cd /FalkorDBBrowser && HOSTNAME="0.0.0.0" node server.js &
fi
fi

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

Consider adding a shebang at the beginning of the script to specify the shell interpreter explicitly, such as #!/bin/bash. This ensures that the script runs under the expected shell environment, improving portability and predictability.

+ #!/bin/bash

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [3-3]

To prevent globbing and word splitting issues, it's recommended to double-quote variables when they are expanded. This is a best practice in shell scripting that enhances the script's robustness and security.

- if [ ${BROWSER:-1} -eq 1 ]
+ if [ "${BROWSER:-1}" -eq 1 ]

- if [ ${TLS:-0} -eq 1 ]
+ if [ "${TLS:-0}" -eq 1 ]

- redis-server --protected-mode no ${REDIS_ARGS:-""} \
+ redis-server --protected-mode no "${REDIS_ARGS:-""}" \

- redis-server --protected-mode no ${REDIS_ARGS} \
+ redis-server --protected-mode no "${REDIS_ARGS}" \

- --loadmodule ${MODULE_DIR}/falkordb.so ${FALKORDB_ARGS:-""}
+ --loadmodule "${MODULE_DIR}/falkordb.so" "${FALKORDB_ARGS:-""}"

- --loadmodule ${MODULE_DIR}/falkordb.so ${FALKORDB_ARGS:-""}
+ --loadmodule "${MODULE_DIR}/falkordb.so" "${FALKORDB_ARGS:-""}"

Also applies to: 11-11, 14-14, 20-20, 22-22, 23-23

@dudizimber dudizimber linked an issue Mar 28, 2024 that may be closed by this pull request
@swilly22 swilly22 merged commit b8ec5ca into master Mar 29, 2024
13 of 14 checks passed
@swilly22 swilly22 deleted the 600-add-browser-usage-for-the-docker-image branch March 29, 2024 12:21
swilly22 added a commit that referenced this pull request Apr 4, 2024
* 600 add browser usage for the docker image (#601)

* add instructions to run browser UI

* set hostname to 0.0.0.0

* fix crash in rewrite call subquery (#604)

* fix crash in rewrite call subquery

* simplified test query

---------

Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* use debug assert in rust (#606)

* fix merge init (#609)

* fix merge init

* remove unused function, simplified branch assignment logic

* clean

---------

Co-authored-by: Roi Lipman <roilipman@gmail.com>

* Unwind persist (#613)

* persist unwind record

* deep clone base record

* Disable jit (#612)

* persist unwind record

* disable GraphBLAS JIT

* version bump

---------

Co-authored-by: Dudi <16744955+dudizimber@users.noreply.github.com>
Co-authored-by: Avi Avni <avi.avni@gmail.com>
swilly22 added a commit that referenced this pull request Apr 16, 2024
* 600 add browser usage for the docker image (#601)

* add instructions to run browser UI

* set hostname to 0.0.0.0

* fix crash in rewrite call subquery (#604)

* fix crash in rewrite call subquery

* simplified test query

---------

Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* use debug assert in rust (#606)

* fix merge init (#609)

* fix merge init

* remove unused function, simplified branch assignment logic

* clean

---------

Co-authored-by: Roi Lipman <roilipman@gmail.com>

* Unwind persist (#613)

* persist unwind record

* deep clone base record

* Disable jit (#612)

* persist unwind record

* disable GraphBLAS JIT

* Update module api (#617)

* update RediSearch submodule

* bump RediSearch version

* updated redis module api header file

* make sure there's a record to emit (#623)

* update RediSearch (#640)

* bump version

---------

Co-authored-by: Dudi <16744955+dudizimber@users.noreply.github.com>
Co-authored-by: Avi Avni <avi.avni@gmail.com>
swilly22 added a commit that referenced this pull request Apr 19, 2024
* 600 add browser usage for the docker image (#601)

* add instructions to run browser UI

* set hostname to 0.0.0.0

* fix crash in rewrite call subquery (#604)

* fix crash in rewrite call subquery

* simplified test query

---------

Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* use debug assert in rust (#606)

* fix merge init (#609)

* fix merge init

* remove unused function, simplified branch assignment logic

* clean

---------

Co-authored-by: Roi Lipman <roilipman@gmail.com>

* Unwind persist (#613)

* persist unwind record

* deep clone base record

* Disable jit (#612)

* persist unwind record

* disable GraphBLAS JIT

* Update module api (#617)

* update RediSearch submodule

* bump RediSearch version

* updated redis module api header file

* make sure there's a record to emit (#623)

* update RediSearch (#640)

* Fix #634 Add Cloud link to README.md (#635)

* fix #645 Add objective to README (#646)

* Add objective to README

* Update wordlist.txt

---------

Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* fix union validation with call subquery (#648)

* Seek by id runtime optimization (#643)

* wip runtime optimization

* fix leak

* fix node by label scan

* fix leak

* fix leak

* address review

* add tests

* address review

* review

* review

* review

* add memory hook to roaring bitmap

* introduce bitmap range

---------

Co-authored-by: Roi Lipman <roilipman@gmail.com>
Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* bump version

---------

Co-authored-by: Dudi <16744955+dudizimber@users.noreply.github.com>
Co-authored-by: Avi Avni <avi.avni@gmail.com>
Co-authored-by: Guy Korland <gkorland@gmail.com>
swilly22 added a commit that referenced this pull request May 13, 2024
* 600 add browser usage for the docker image (#601)

* add instructions to run browser UI

* set hostname to 0.0.0.0

* fix crash in rewrite call subquery (#604)

* fix crash in rewrite call subquery

* simplified test query

---------

Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* use debug assert in rust (#606)

* fix merge init (#609)

* fix merge init

* remove unused function, simplified branch assignment logic

* clean

---------

Co-authored-by: Roi Lipman <roilipman@gmail.com>

* Unwind persist (#613)

* persist unwind record

* deep clone base record

* Disable jit (#612)

* persist unwind record

* disable GraphBLAS JIT

* Update module api (#617)

* update RediSearch submodule

* bump RediSearch version

* updated redis module api header file

* make sure there's a record to emit (#623)

* update RediSearch (#640)

* Fix #634 Add Cloud link to README.md (#635)

* fix #645 Add objective to README (#646)

* Add objective to README

* Update wordlist.txt

---------

Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* fix union validation with call subquery (#648)

* Seek by id runtime optimization (#643)

* wip runtime optimization

* fix leak

* fix node by label scan

* fix leak

* fix leak

* address review

* add tests

* address review

* review

* review

* review

* add memory hook to roaring bitmap

* introduce bitmap range

---------

Co-authored-by: Roi Lipman <roilipman@gmail.com>
Co-authored-by: Roi Lipman <swilly22@users.noreply.github.com>

* zero dim vector save/load (#654)

* update redisearch, do not escape TAG field (#667)

* Code coverage (#674)

* add coverage build

* rename

* fix

* fix cache

* install redis in coverage

* ignore some path in code coverage (#678)

* Ref count record (#663)

* ref count record

* nullify record on deletion

* handle record ref count within execution plan return record

* address PR comments

* remove head & tail calls to persist

* trying to simplify and make value passing safer and simpler

* free aggregated group once yield

* removed Record_PersistScalars

* removed override flag

* remove extra persists

* group no longer holds a keys array

* only persists keys which are not graph entities

* allow for record cloning from different execution plans

---------

Co-authored-by: Dudi <16744955+dudizimber@users.noreply.github.com>
Co-authored-by: Avi Avni <avi.avni@gmail.com>
Co-authored-by: Guy Korland <gkorland@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add browser usage for the docker image DB Browser only listening on 127.0.0.1
2 participants