Welcome to Superdesk documentation¶
At Sourcefabric, we develop open-source software for journalism
Welcome. This is the home of Superdesk technical documentation. You will learn here mainly about the Superdesk server application.
For technical documentation on the Superdesk client web application, have a look here.
Note
Looking for non-technical user documentation?
We’ve got you covered. Check out the User Manual.
First steps¶
New to Superdesk? This is the best place to start. Here you will get the big picture of how the Superdesk server works.
Reference¶
Check out this technical reference to understand in detail how the Superdesk server works and can be developed further.
- Architecture
- Publishing
- Ingest
- Spellchecking
- AI/Machine Learning Services
- Configuration
- Default settings
- Mongo connections
- Elastic settings
- Redis settings
- Cache settings
- Celery settings
- Monitoring settings
- LDAP settings
- Media settings
- Amazon S3 settings
- Security settings
- Email settings
- Content API Settings
- Google OAuth Settings
- SAML Auth Settings
- OpenID Connect Auth Settings
- Schema and Editor
- Other
- Extend Superdesk
- Video server settings
- Item Schema
- Content Profiles
- Content API
- Editor
- Rendering customisation
- Authentication Server
- Production API Server
- Video server
- Extending Superdesk
- Authentication
- Superdesk CLI
- Storage Dumps and Records
- Signals in Superdesk
- Testing
- Push Notifications
Additional topics¶
Learn about other important core aspects of working with the Superdesk server.
Contributing¶
Interested in contributing to the Superdesk project? Here you can learn how to give us a hand by helping us to either improve this documentation or writing some code.