vCards

导入常用联系人头像，优化 iOS 来电、信息界面体验。更多信息请访问 vCards⁠。

Pulling Images

You can pull the images using the following commands:

docker pull funnyzak/vcards:latest
# GHCR 
docker pull ghcr.io/funnyzak/vcards:latest
# Aliyun
docker pull registry.cn-beijing.aliyuncs.com/funnyzak/vcards:latest

Environment Variables

• SYNC_CRON: Sync schedule, default is not set. For example, 0 0 * * * means sync every day at 00:00. You can use CronTab⁠ to generate the schedule.

Volumes

• /app/downloads: New data will be downloaded to this folder.
• /app/vcards/collection-root/cn/: The cn folder of the contacts.

Usage

Docker Deployment

Use the default contacts data, and map to local 5232 port.

docker run -d --name vcard \
    -p 5232:5232 \
    funnyzak/vcards:latest

Use custom contacts data, and map to local 5232 port.

docker run -d --name vcard \
    -p 5232:5232 \
    -v ./vcards:/app/vcards/collection-root/cn/ \
    funnyzak/vcards:latest

Sync every day at 00:00, and download new data to ./downloads folder.

docker run -d --name vcard \
    -p 5232:5232 \
    -e SYNC_CRON="0 0 * * *" \
    -v ./downloads:/app/downloads \
    funnyzak/vcards:latest

Sync every day at 00:00, and download new data to ./downloads folder, and add custom contacts data to vcards folder.

docker run -d --name vcard \
    -p 5232:5232 \
    -e SYNC_CRON="0 0 * * *" \
    -v ./downloads:/app/downloads \
    -v ./vcards:/app/vcards/collection-root/cn/ \
    funnyzak/vcards:latest

Note: You must download the contacts data from vCards⁠ and put it in the vcards folder.

Docker Compose Deployment

version: '3.7'

services:
  vcard:
    image: funnyzak/vcards:latest
    container_name: vcard
    ports:
      - 5232:5232
    environment:
      - SYNC_CRON=0 0 * * *
    volumes:
      - ./downloads:/app/downloads

Setup on iOS and Mac

Deploy the vCards service, and add the following information to the CardDAV account:

• Server: vcards.youdeployed.com
• User name: cn
• Password: cn or whatever you want

Steps:

1. iOS⁠: Settings - Contacts - Accounts - Add Account - Other - Add CardDAV Account.
2. Mac⁠: Contacts - Settings - Accounts - Other Contacts Accounts.

When syncing is complete, you can see the contacts in the Contacts app.

More information can be found at vCards⁠.