Twikoo Documentation

Twikoo's architecture is split into two distinct parts that must be deployed and kept in sync:

1. Cloud Functions: The backend logic that handles data storage and processing. You must choose a deployment platform (e.g., Vercel, Netlify, AWS Lambda, etc.) that suits your needs.
2. Front-end: The client-side component that renders the comment interface on your website.

Critical Requirement: You must ensure that both the cloud function version and the front-end version are consistent to avoid compatibility issues.

By default, the MongoDB Atlas connection string does not specify a database name, so Twikoo will connect to the default test database.

If you want to run multiple Twikoo instances or other services within the same MongoDB cluster, you should append the specific database name to your connection string and ensure the corresponding Access Control List (ACL) is configured.

If you used the one-click deployment method on Tencent Cloud, follow these steps to update:

1. Log in to Environment - My Applications.
2. Enter the following configuration:
   • Source Address: https://github.com/twikoojs/twikoo/tree/main
   • Deployment Branch: main
3. Leave the Application Directory empty.
4. Click Confirm to complete the deployment.

Important: After a successful update, you must also update the version number (x.x.x) in your frontend Twikoo CDN address to match the cloud function version, then redeploy your website.

Requires twikoo.js version 1.4.0 or higher. Note that *.vercel.app domains may be slow or inaccessible in mainland China; binding a custom domain is recommended.

Steps:

1. Obtain a MongoDB connection string from MongoDB Atlas.
2. Click the Deploy to Vercel button.
3. In Vercel, go to Settings -> Environment Variables and add:
   • Key: MONGODB_URI
   • Value: Your MongoDB connection string.
4. In Settings -> Deployment Protection, set Vercel Authentication to Disabled and Save.
5. Go to Deployments, click the three dots on any deployment, and select Redeploy.
6. Your environment ID is the Vercel Domain (e.g., https://xxx.vercel.app).

Deploy Twikoo to Hugging Face using Docker. Warning: Email functionality is unavailable on Hugging Face because the default email port is blocked.

1. Get a MongoDB connection string from MongoDB Atlas.
2. Create a new Space on Hugging Face with the Docker SDK and a Blank template.
3. In the Space Settings, add a new secret named MONGODB_URI with your connection string.
4. Create a new file named Dockerfile in the Space and add the following content:

FROM imaegoo/twikoo
ENV TWIKOO_PORT 7860
EXPOSE 7860

5. Commit the file. Your Environment ID is the Direct URL found in the Space settings (e.g., https://xxx-xxx.hf.space).

If you are contributing to the project or developing locally, use the following commands to manage the development environment:

• yarn dev: Starts the local development server (typically accessible at http://localhost:9820/demo.html).
• yarn lint: Runs linting checks.
• yarn build: Builds the project, generating the production file at dist/twikoo.all.min.js.

yarn dev # (http://localhost:9820/demo.html)
yarn lint 
yarn build # (dist/twikoo.all.min.js)

Pre-built versions of the Twikoo executable can be downloaded from the official release page.

https://github.com/kongxiangyiren/twikoo-pkg/releases/latest

Once go-cqhttp is running, use the following URL formats in the Twikoo QQ Private API configuration settings. Replace IP:PORT with your server's address and token with the access-token defined in your config.yml.

For Private Messages (QQ Number): http://<YOUR_IP>:<PORT>/send_private_msg?user_id=<QQ_NUMBER>?token=<YOUR_TOKEN>

For Group Messages: http://<YOUR_IP>:<PORT>/send_group_msg?token=<YOUR_TOKEN>?group_id=<GROUP_ID>