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

Update readme #934

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update readme #934

wants to merge 2 commits into from

Conversation

magopian
Copy link

Update the README with more detailed step by step instructions.

Changes

  • Add a couple of more detailed steps for the repository cloning and docker usage
  • Replace the pgadmin screenshots with an updated version, and more detailed steps and instructions on what data to fill in to connect to the server

Copy link
Member

@qgerome qgerome left a comment

Choose a reason for hiding this comment

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

Thanks for your first PR :)

cp .env.dist .env # adapt the .env file with the required configuration values
# Set WORKSPACE_STORAGE_LOCATION to a local directory to use a local storage backend for workspaces
export WORKSPACE_STORAGE_LOCATION=../data
Copy link
Member

Choose a reason for hiding this comment

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

Not documented neither but it's expected to be an absolute path as it's going to be used to mount the data directory as a volume inside the JupyterLab containers (see hexa/workspaces/views.py, hexa/files/backends/fs.py & blsq/openhexa-notebooks)
I'd recommend to check in settings/base.py if it's a abs path (raise or change it as a abs path 🤷🏻)

YolanFery pushed a commit that referenced this pull request Apr 2, 2025
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants