rusackas commented on code in PR #28221: URL: https://github.com/apache/superset/pull/28221#discussion_r1733298864
########## docs/docs/installation/pypi.mdx: ########## @@ -134,21 +130,40 @@ First, start by installing `apache-superset`: pip install apache-superset ``` -Then, you need to initialize the database: +Superset configurations are stored in a file. One of these configurations, a `SECRET_KEY`, is required for the application to start. Create your config file: +``` +touch superset/superset_config.py +``` +And make this file findable by adding its path as an environment variable: +``` +export SUPERSET_CONFIG_PATH=superset/superset_config.py +``` +Note that this stores the path in the environment only temporarily. If you wish for this to persist through reboots, permanently set this environment variable by [adding it to your `~/.profile` file](https://unix.stackexchange.com/questions/117467/how-to-permanently-set-environmental-variables). -```bash -superset db upgrade +Now generate a strong value for `SECRET_KEY` and write it to your config file: ``` +echo "SECRET_KEY='$(openssl rand -base64 42)'" | tee -a superset/superset_config.py +``` +Do not lose this key. Consider maintaining a secure backup of your `superset_config.py` file. -:::tip -Note that some configuration is mandatory for production instances of Superset. In particular, Superset will not start without a user-specified value of SECRET_KEY. Please see [Configuring Superset](/docs/configuration/configuring-superset). -::: +You could also tell Superset where to store its metadata - that is, what charts, dashboards, etc. have been created. By default, this is a SQLite database at the filepath `~/.superset/superset.db`. -Finish installing by running through the following commands: +In a production setup, you would change this to point to say, a PostgreSQL database that gets backed up. You change this by specifying a new value in `superset_config.py` for the variable `SQLALCHEMY_DATABASE_URI`. Review Comment: ```suggestion In a production setup, you would change this to point to, for example, a PostgreSQL database that gets backed up. You change this by specifying a new value in `superset_config.py` for the variable `SQLALCHEMY_DATABASE_URI`. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
