How-to guides

Here you can find a collection of guides on a variety of topics. These are aimed at active users of Renku and target specific use-cases or common issues.

• Sessions on RenkuLab
  • Stopping and Saving
  • Customizing sessions
  • Upgrading your Renku project
  • Running RenkuLab Interactive Sessions on Your Own Machine
  • Mounting S3 Buckets in Renku Sessions
• Command-line Interface Installation
  • Using the CLI on RenkuLab
  • Local installation with the script manager pipx
  • pip/pipenv
  • Installing from source
• Import Existing Project
  • Practical Renku Usage & Migration Tips
  • Create an account on Renku & set up GitLab SSH key
  • Renku-ize your project with Renku CLI
  • Push your project to RenkuLab
  • View your project on renkulab.io
• Collaborating on Renku
  • Finding & accessing public projects
  • Fork a project and take it in your own direction
  • Add collaborators to the conversation through Issues
  • Add or be added as a developer on a project
• Git cheat sheet for Renku
• Troubleshooting
  • CLI installation problems
• Guides for developers and administrators
  • Deploying Renku
  • Enabling notebooks for anonymous users
  • Running the platform
  • Configuring privacy page and cookie banner
  • Troubleshooting a Renku deployment
• Contributing to Renku
  • Open a pull request
  • Documentation
  • REST API guidelines