Documentation Status Map

This is a map of all of the pimentaCHAT Documentation articles

Here you can also find what articles are incomplete and missing.

Red Colored Text means that this article is missing from the documentation and need to be added.

Orange Colored Text means that this article is in the documentation but is incomplete or outdated.

Contributing
Getting Support
User guides:
Administrator guides:
- Account Settings
- Analytics
- Auto Translation
- Authentication:
  - CAS
  - Ldap
  - Oauth
  - SAML
  - WordPress
  - Custom Oauth
  - Using pimentaCHAT as an Oauth provider
  - oauth2 o365
  - Customizing the UI:
  - Layout
  - Assets
- Custom Emoji
- Custom Fields
- Custom Sounds
- Database-Migration
- Email:
  - Setup
  - Editing Emails Content
  - Mailer
  - Direct Reply
- File Upload:
  - Amazon S3
  - Google Cloud Storage
  - Minio
  - WebDAV
  - GridFS
  - Local File System
- General Settings
  - General Section
  - Message Section
- Import:
  - CSV:
  - HipChat: - HipChat Cloud - HipChat Server/Data Center
  - Slack: - SlackBridge
- Integrations:
  - Zapier:
    - Using Zaps
  - Azure Alerts
  - BitBucket
  - Gif.pimenta
  - GitHub
  - GitLab
  - Google-Calendar
  - Guggy
  - Jenkins
  - Jira
  - NewRelic
  - nixstats
  - PagerDuty
  - Prometheus
  - RunDeck
  - Sentry
  - Telegram
  - Travis CI
  - Trello
  - uptimerobot
- pimentaLIVE
- Livechat:
  - Livechat Queues
- Notifications:
  - Push Notifications
- Permissions
- Plug-ins:
  - Drupal
  - Pidgin
- Create the First Admin
- Restoring an Admin
- Settings Via Env Vars
Developer guides:
- Quick Start
- Branches and Releases
- Code Styleguide:
  - Less
- Deeplink
- Deprecation
- Iframe Integration:
  - Authentication
  - Commands
  - Events
- Embedded Layout
- Internationalization
- Livechat API
- Mobile Apps
  - Supporting SSL
  - Supported Servers Versions
- Realtime-API:
  - Method Calls:
    - Login
    - Logout
    - Register User
    - Get User Roles
    - List Custom Emoji
    - Load History
    - Get Room Roles
    - Get Subscriptions
    - Get Rooms
    - Get Public Settings
    - Get Permissions
    - User Presence
    - Notify Room Stream
    - Create Direct Message
    - Send Message
    - Delete Message
    - Update Message
    - Pin Message
    - Unpin Message
    - Set Reaction
    - Create Channels
    - Create Private Groups
    - Delete Rooms
    - Archive Rooms
    - Unarchive Rooms
    - Joining Channels
    - Leaving Rooms
    - Hiding Rooms
    - Opening Rooms
    - Favoriting Rooms
    - Save Room Settings
  - Subscriptions:
    - Stream Notify All
    - Stream Notify User
    - Stream Notify Room
    - Stream Room Messages
  - The Message Object
  - The Room Object
  - Livechat API:
    - getInitialData
    - registerGuest
    - sendMessageLivechat
    - sendOfflineMessage
  - Rest API:
  - Assets:
    - setAsset
    - unsetAsset
  - Authentication:
    - facebook
    - forgotPassword
    - google
    - login
    - logout
    - me
    - twitter
  - Channels:
    - addAll
    - addModerator
    - addOwner
    - archive
    - close
    - counters
    - create
    - delete
    - files
    - getAllUserMentionsByChannel
    - getIntegrations
    - history
    - info
    - invite
    - join
    - kick
    - leave
    - list.joined
    - list
    - members
    - moderators
    - messages
    - open
    - removeModerator
    - removeOwner
    - rename
    - roles
    - setAnnouncement
    - setCustomFields
    - setDefault
    - setDescription
    - setJoinCode
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Chat:
    - delete
    - getMessage
    - getMessageReadReceipts
    - pinMessage
    - postMessage
    - react
    - reportMessage
    - search
    - starMessage
    - sendMessage
    - unPinMessage
    - unStarMessage
    - update
  - Commands:
    - get
    - list
    - run
  - Groups:
    - addAll
    - addModerator
    - addOwner
    - archive
    - close
    - counters
    - create
    - delete
    - files
    - getIntegrations
    - history
    - info
    - invite
    - kick
    - leave
    - list
    - listAll
    - members
    - messages
    - moderators
    - open
    - removeModerator
    - removeOwner
    - rename
    - roles
    - setAnnouncement
    - setCustomFields
    - setDescription
    - setPurpose
    - setReadOnly
    - SetTopic
    - setType
    - unarchive
  - Im:
    - close
    - counters
    - create
    - files
    - history
    - list.everyone
    - list
    - members
    - messages
    - messages.others
    - open
    - setTopic
  - Integration:
    - create
    - history
    - list
    - remove
  - Livechat:
    - agent
    - config
    - custom-fields
    - department
    - message
    - room
    - sms-incoming
    - users
    - video-call
  - Miscellaneous:
    - directory
    - info
    - shield.svg
    - spotlight
    - statistics
    - statistics.list
  - Permissions:
    - list
    - update
  - Roles:
    - create
    - list
    - addUserToRole
  - Push:
    - push.token
    - deletePushToken
  - Rooms:
    - cleanHistory
    - favorite
    - get
    - info
    - leave
    - saveNotification
    - upload
  - Settings:
    - get
    - update
    - oauth
  - Subscriptions:
    - get
    - getOne
    - read
    - unread
  - Users:
    - create
    - createToken
    - delete
    - deleteOwnAccount
    - forgotPassword
    - generatePersonalAccessToken
    - getAvatar
    - getPersonalAccessTokens
    - getPresence
    - get-preferences
    - getUsernameSuggestion
    - info
    - list
    - regeneratePersonalAccessToken
    - register
    - removePersonalAccessToken
    - resetAvatar
    - setAvatar
    - set-preferences
    - update
    - updateOwnBasicInfo
  - pimentaLIVE:
    - pimentalive-update-timeout
  - Offset and Count and Sort Info
  - Query and Fields Info
  - Personal Access Tokens
  - Schema Definition
  - Testing
  - Troubleshooting
  - UI and Theming:
  - Colors
  - Components
  - Themes
  - GraphQL API:
    - Authentication
    - Schema
    - Subscription
Developer Guides
- Installation:
  - pimentaCLOUD
  - PaaS Deployments: - Aliyun - [AWS] - [Cloudron.io] - [Digital Ocean] - [DPlatform] - [Galaxy6] - [Google Computer Engine] - [Heroku] - [Hyper.sh] - [IBM Bluemix] - [Layershift] - [OpenShift] - [ReadySpace] - [Sandstorm.io] - [WeDeploy]
  - Docker containers: - Generic Linux - systemd - High Availability Install - Available Images - Docker Compose
  - Manual Installation: - CentOS - Debian - MacOSX - Multiple Instances to Improve Performance - Migrating Meteor Mongo - OpenSUSE - RedHat - Ubuntu: - Snaps: - AutoSSl - Mongo Options - Configuring SSL Reverse Proxy - PM2, Systemd, Upstart - Running in a sub folder
- Automation tools:
  - Ansible
  - Openshift
  - Vagrant
- Mobile and Desktop Apps
- Updating
  - From 0.x.x to 0.40.0
- Minimum Requirements
- Community Supported Install:
  - FreeBSD
    - Universal
  - Windows 10 Pro
  - Windows Server:
Bots:
- Bots FAQ
- Bots Architecture
- Creating Bot Users
- Configure Bot Environment
- Running a bBot Bot
- Running a Hubot Bot
- Running a Botkit Bot
- Running a Rasa Bot
- Running a Botpress Bot
Community Cookbook:
- Remote Video Monitoring

Contribute to our growth with your feedback