# Twake

## Twake

- [☀️ Twake](https://doc.twake.app/master.md)
- [Use Twake on twake.app](https://doc.twake.app/gettingstarted/use-twake-on-twake.app.md): Ready to use Twake with your team?
- [Install on your server](https://doc.twake.app/gettingstarted/installation.md): How to install Twake
- [Scale with Twake](https://doc.twake.app/gettingstarted/installation/scale-with-twake.md): You need Twake for more than 500 users ? You want to leverage ScyllaDB and ElasticSearch replication ? You are in the right place !
- [Configuration](https://doc.twake.app/gettingstarted/configuration.md): More details about Twake configuration.
- [Security](https://doc.twake.app/gettingstarted/configuration/security.md): You should update this security keys to ship Twake in production.
- [Custom domain + HTTPS](https://doc.twake.app/gettingstarted/configuration/custom-domain-and-https.md): Use a custom domain with Twake
- [Apache2 configuration](https://doc.twake.app/gettingstarted/configuration/custom-domain-and-https/apache2-configuration.md): 🙏 From Dahpril (community) https://github.com/TwakeApp/Twake/issues/76
- [Configure mail server](https://doc.twake.app/gettingstarted/configuration/configure-mail-server.md): To configure your mail serveur with Twake.
- [Customisation](https://doc.twake.app/gettingstarted/configuration/customisation.md): How to make Twake feel better in your company.
- [Connectors and plugins](https://doc.twake.app/gettingstarted/configuration/connectors-and-plugins.md): You can connect anything you want on Twake, read this to know how.
- [👨‍💻 Authentication modes](https://doc.twake.app/gettingstarted/configuration/authentication-modes.md): Twake let you authenticate using CAS or OpenID.
- [Using Keycloak (LDAP, OpenID and more)](https://doc.twake.app/gettingstarted/configuration/authentication-modes/using-keycloak-ldap-openid-and-more.md): Use Keycloak with Twake
- [Installing Twake with LemonLDAP (LDAP, OpenID and more)](https://doc.twake.app/gettingstarted/configuration/authentication-modes/installing-twake-with-lemonldap-ldap-openid-and-more.md): Harder than KeyCloak but has other features, see official LemonLDAP site.
- [Welcome to Twake !](https://doc.twake.app/how-to-use-it/welcome.md): Discover how to use Twake
- [Console](https://doc.twake.app/how-to-use-it/console.md): How to use the Twake console
- [Users](https://doc.twake.app/how-to-use-it/console/users.md): How users are managed in the Twake console
- [Company & workspace](https://doc.twake.app/how-to-use-it/company-and-workspace.md): How company and workspace work on Twake
- [Invite user from Chat](https://doc.twake.app/how-to-use-it/company-and-workspace/invite-user-from-chat.md): Invite user from Twake
- [Rights](https://doc.twake.app/how-to-use-it/company-and-workspace/rights.md): How rights are managed on Twake
- [Applications](https://doc.twake.app/how-to-use-it/applications.md): Discover Twake application
- [Chat](https://doc.twake.app/how-to-use-it/applications/how-to-use-chat.md): How Twake chat is working
- [Channels](https://doc.twake.app/how-to-use-it/applications/how-to-use-chat/channels.md): Discover how channels are used on Twake
- [Message](https://doc.twake.app/how-to-use-it/applications/how-to-use-chat/message.md): Send message on Twake
- [Drive](https://doc.twake.app/how-to-use-it/applications/drive.md): How you can use the drive on Twake
- [File and folder](https://doc.twake.app/how-to-use-it/applications/drive/file-and-folder.md): How you can create file & folder on Twake
- [Share file with public link](https://doc.twake.app/how-to-use-it/applications/drive/share-file-with-public-link.md): How you can share your files with a public link
- [Calendar](https://doc.twake.app/how-to-use-it/applications/calendar.md): How to use Twake calendar
- [Tasks](https://doc.twake.app/how-to-use-it/applications/tasks.md): How to use Twake task
- [Connectors](https://doc.twake.app/how-to-use-it/applications/connectors.md): How to add connector on Twake
- [n8n](https://doc.twake.app/how-to-use-it/applications/connectors/n8n.md): Did you ever dreamed to use Twake and n8n together ?
- [Desktop and mobile app](https://doc.twake.app/how-to-use-it/desktop-and-mobile-app.md): Yes, we have desktop and mobile apps !
- [Privacy](https://doc.twake.app/how-to-use-it/privacy.md)
- [Home](https://doc.twake.app/developers-api/home.md): Welcome to the developers API home, here you can create apps, plugins and connectors for Twake.
- [Getting started](https://doc.twake.app/developers-api/get-started.md): Welcome to the developers API of Twake, let's begin together
- [Create your first application](https://doc.twake.app/developers-api/get-started/create-your-first-application.md): You want to create an application for Twake? It's easy, just follow the steps in this documentation! 😀
- [Authenticate with Postman](https://doc.twake.app/developers-api/get-started/authenticate-postman.md): Postman example
- [Send a message with your application](https://doc.twake.app/developers-api/get-started/send-a-message-for-twake.md): Send a message through API
- [Trigger action from command](https://doc.twake.app/developers-api/get-started/trigger-action-from-command.md): Trigger action from command
- [Application settings](https://doc.twake.app/developers-api/application-settings.md): Set your application
- [Api](https://doc.twake.app/developers-api/application-settings/api.md): There you will find some important pieces of information
- [Display](https://doc.twake.app/developers-api/application-settings/application-visibility-example.md): This is a JSON parameter to define where your app should appear
- [Privileges](https://doc.twake.app/developers-api/application-settings/privileges.md): Which privileges you need for your app
- [Identity](https://doc.twake.app/developers-api/application-settings/identity.md): How Identity are managed
- [API Reference](https://doc.twake.app/developers-api/api-reference.md): Discover our wonderful API
- [Webhook](https://doc.twake.app/developers-api/api-reference/wehbook.md): How to use webhook with Twake
- [Drive](https://doc.twake.app/developers-api/api-reference/drive.md): How to manage Drive through API
- [Message](https://doc.twake.app/developers-api/api-reference/message.md): How to manage messages through API
- [DELETE Request](https://doc.twake.app/developers-api/api-reference/message/delete-request.md): This method allow to delete message to a specific channel.
- [POST Request](https://doc.twake.app/developers-api/api-reference/message/post-request.md): This method allow to send message to a specific channel.
- [Authentication](https://doc.twake.app/developers-api/api-reference/auth.md): How to manage authentification on API call
- [Blocks](https://doc.twake.app/developers-api/blocks.md)
- [Get started](https://doc.twake.app/internal-documentation/get-started.md): Welcome to the internal documentation section. This chapter is for developers working in Twake team or wanting to participate in the project.
- [Twake Ecosystem Guidelines](https://doc.twake.app/internal-documentation/twake-ecosystem-guidelines.md): Global guidelines for any new projects around Twake, Frontend and Backend guidelines are discussed here.
- [Our stack](https://doc.twake.app/internal-documentation/our-stack.md): Here is the list of our middlewares and their usages.
- [Backend and APIs](https://doc.twake.app/internal-documentation/backend-services.md): This page will document all the services implemented in the new NodeJS backend. For all the PHP services not yet migrated, please ask us directly on https://community.twake.app/
- [(WIP) Authentication](https://doc.twake.app/internal-documentation/backend-services/authentication.md): Routes to identify your user or your application.
- [Users and workspaces](https://doc.twake.app/internal-documentation/backend-services/users-and-workspaces-service.md): How users and workspaces are managed in backend
- [Applications](https://doc.twake.app/internal-documentation/backend-services/applications.md): How applications are managed in Twake backend
- [Database models](https://doc.twake.app/internal-documentation/backend-services/applications/database-models.md): Application models for backend
- [REST APIs](https://doc.twake.app/internal-documentation/backend-services/applications/rest-apis.md): Rest API for application
- [Channels and tabs](https://doc.twake.app/internal-documentation/backend-services/channels-service.md): Channels are topics in Twake, users can subscribe to them, can make them private or can create them.
- [Database models](https://doc.twake.app/internal-documentation/backend-services/channels-service/database-models.md): Database models of channel
- [Messages](https://doc.twake.app/internal-documentation/backend-services/messages-service.md): Message api
- [Database models](https://doc.twake.app/internal-documentation/backend-services/messages-service/database-model.md): Message database models
- [Files](https://doc.twake.app/internal-documentation/backend-services/files-service.md): File on Twake
- [Database models](https://doc.twake.app/internal-documentation/backend-services/files-service/database-models.md): File database models
- [REST APIs](https://doc.twake.app/internal-documentation/backend-services/files-service/rest-apis.md): Rest api for files
- [Resumable.js](https://doc.twake.app/internal-documentation/backend-services/files-service/resumablejs.md): How we use resumable on Twake
- [Notifications](https://doc.twake.app/internal-documentation/backend-services/notifications-service.md): Notifications on Twake
- [Database models](https://doc.twake.app/internal-documentation/backend-services/notifications-service/database-models.md): Notification database model
- [Twake service development](https://doc.twake.app/internal-documentation/backend-services/twake-service-development.md): Get started with Twake service development
- [What is a service in Twake ?](https://doc.twake.app/internal-documentation/backend-services/twake-service-development/start-working-into-a-service.md): You want to add new routes in an existing service, for instance add a feature to our channel service ? You are in the right place !
- [Create a new service](https://doc.twake.app/internal-documentation/backend-services/twake-service-development/create-a-new-twake-service.md): If you are here, you probably have a very great idea for Twake, like adding a brand new feature into Twake, maybe a coffee maker service ? ☕️
- [Platform/Technical services](https://doc.twake.app/internal-documentation/backend-services/twake-service-development/platform.md): List of core shared components in Twake backend, available in src/core/platform/services
- [Database ORM platform service](https://doc.twake.app/internal-documentation/backend-services/twake-service-development/platform/database-orm-platform-service.md)
- [Web, desktop and mobile](https://doc.twake.app/internal-documentation/frontend-components.md): Get started with Twake frontend.
- [Table](https://doc.twake.app/internal-documentation/frontend-components/table.md): Create a table
- [ObjectModal](https://doc.twake.app/internal-documentation/frontend-components/objectmodal.md): A beautiful, centered, medium modal with all you need to structure its content.
- [ObjectModalTitle](https://doc.twake.app/internal-documentation/frontend-components/objectmodal/objectmodaltitle.md): Main title for the ObjectModal component.
- [ObjectModalSeparator](https://doc.twake.app/internal-documentation/frontend-components/objectmodal/objectmodalseparator.md): Separate your component sections with a simple line.
- [ObjectModalSectionTitle](https://doc.twake.app/internal-documentation/frontend-components/objectmodal/objectmodalsectiontitle.md): Section title, perfect after a separator.
- [ObjectModalFormTitle](https://doc.twake.app/internal-documentation/frontend-components/objectmodal/objectmodalformtitle.md): Icon with sub heading for ObjectModal component. Perfect before a form field.
- [UserListManager](https://doc.twake.app/internal-documentation/frontend-components/userlistmanager.md): Not documented yet?
- [MediumPopupManager](https://doc.twake.app/internal-documentation/frontend-components/mediumpopupmanager.md): Not documented yet.
- [MenuManager](https://doc.twake.app/internal-documentation/frontend-components/menumanager.md): Not documented yet.
- [Translation](https://doc.twake.app/internal-documentation/translation.md): Want to translate Twake ?


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://doc.twake.app/master.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.