Welcome to Stackspin’s documentation!

Stackspin is a platform that offers self-managed, click-and-play provisioning of online applications for Civil Society Organisations (CSOs). Users will be able to easily set up a self-hosted instance of Stackspin, so they can keep control over the data that gets entered into these applications.

Stackspin is:

• Open Source

• Self updating

• Easy to deploy

• Integrated

For more information, go to the Stackspin website.

Installation

• Installation overview
  • Preparing the provisioning machine
  • Create a python virtual environment (Optional)
  • Install the requirements
  • Stackspin CLI client usage
• Create and configure a kubernetes cluster
• Install Stackspin
  • Step 1: Flux configuration
  • Step 2: Install core applications
  • Step 3: Install additional applications
  • Step 4: Validate setup
  • Step 5: Let us know!
• Test your installation
  • Stackspin installation
  • Command line tests
  • Testing Instructions for all apps
  • Testing Instructions for specific apps
  • Providing feedback

Usage

• Manage Stackspin
  • Logging in
  • Login and logout limitations
  • Dashboard
  • Users
  • Plugins
• Applications
  • Dashboard
  • Grafana
  • Nextcloud
  • Onlyoffice
  • Zulip
  • Wekan
  • WordPress
  • HedgeDoc

System Administration

• Migrating application data
  • Nextcloud
  • Wekan
  • WordPress
  • Zulip
• Logging
• Monitoring
  • Grafana
  • Prometheus
  • Alertmanager
  • Email alerts
• Maintenance
  • Backup
  • Restore
  • Change the IP of your cluster
  • Delete evicted pods
  • Run Nextcloud occ commands
• Upgrades
  • Automated upgrades
  • Manual upgrades
• Customizing
  • Prerequisites
  • Customize Stackspin applications
  • Custom dashboard styling
  • Custom flux repository
  • Custom domain names for applications
• External Apps
  • Adding non-native stackspin apps
• Troubleshooting
  • Known issues
  • SSH access
  • Using kubectl to debug your cluster
  • HTTPS certificates
  • Purge Stackspin and install from scratch
• Testing
  • Testinfra tests
  • End to end tests
• Security
  • Access control

For Developers

• Contributing
  • Code of conduct
  • Preparing the development environment
  • Adding dependencies
  • CI pipeline image
• Maintenance
  • Renovatebot
  • Gitlab token refreshing
• Stackspin Design
  • Application build pipeline
  • Configuration
  • Application containers
  • Persistent data
  • Automatic updates
  • APIs

Reference

• Reference documentation
  • File structure
• Comparable projects
  • What makes Stackspin unique
  • Platforms
• Single sign-on Architecture
  • Overview
  • Flows
  • Configuring OIDC clients