Docker Deployment
Image Editions
Teable offers both Enterprise Edition (EE) and Community Edition (CE) images. Add the -ee
suffix to the image name to switch to the EE.
The EE is now in the preview test, mail to support@teable.io we will give a 1-month trial license
The EE allows free use of all CE features and supports Enterprise-exclusive features through License subscription. You can view Enterprise features on the pricing page. EE data is compatible with the CE, and you can switch between versions.
The CE is built from open-source code and does not include any Enterprise features. Its data is compatible with the EE, and you can switch to the EE at any time.
Docker Compose Deployment
Recommended Scale: 0-1000 users
Advantages | Disadvantages |
---|---|
Simple deployment | Single-machine deployment, complex scaling |
Full control | |
Flexible configuration |
Server Requirements
Ensure your server meets these basic requirements:
- Operating System: Recommended Linux distribution, such as Ubuntu 20.04 LTS
- Memory: Minimum 4GB RAM
- CPU: At least 2 cores
- Disk Space: Minimum 40GB available space
- Network: Stable internet connection with necessary port access
Prerequisites
Before starting, ensure you have:
- Basic understanding of Docker and containerization principles
- Docker and Docker Compose installed on your machine. Visit the official Docker documentation for installation guides.
Installing Docker
Installing the Application
1. Create docker-compose.yaml File
Access your server, create and enter the teable folder:
Create a docker-compose.yaml
and a .env
file, then paste the following content:
Minimal Deployment:
Start the Application
Run the following commands in the current directory to start the application. Once started, you can access the application at 127.0.0.1:3000
HTTPS environment is required for large-scale data copying operations, otherwise asynchronous clipboard access will not be possible
Using Managed Databases (Optional)
If you prefer to use managed databases, you can further simplify the deployment process:
- Remove services.teable-db
- Remove service.teable-db-migrate.depends_on
- Remove volumes.teable-db
- Update .env with your managed database configuration
Fill in the database parameters with your managed database connection parameters:
Note that 127.0.0.1
is the container’s internal network. If you want to connect to a locally deployed database, use host.docker.internal
instead of 127.0.0.1
as the host address, otherwise the connection will fail
Similarly for external managed Redis:
- Remove service.teable-cache
- Remove service.teable.depends_on.teable-cache
- Remove volumes.teable-cache
- Update .env with your managed Redis configuration
Next Steps
Configure External Base Connection
Support and Feedback
If you encounter any issues during deployment, please contact our support team at support@teable.io or submit an issue.
License
Teable CE is open source under the AGPL-3.0 license. For EE, please contact us for commercial licensing.