MySQL Setup Guide

Docker Compose Blueprint

While SQLite is the default lightweight choice, nLink fully supports migrating to MySQL for heavy-duty deployments. For advanced JSONB scenarios, you might also consider PostgreSQL. The configuration below provisions the container, initializes the root user, and mounts a persistent volume to ensure your data survives container restarts.

  mysql_db:
    image: mysql:8.0
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: root_secret
      MYSQL_DATABASE: nlink_db
    # Optional: Expose port if you want to connect via external GUI tools
    # ports:
    #   - "3306:3306"
    volumes:
      - mysql_data:/var/lib/mysql

volumes:
  mysql_data:

Connection Attributes

• Engine Version: mysql:8.0
  (We highly recommend using version 8.0 or newer to support the native JSON storage capabilities utilized by nLink).
• Root Password: root_secret
  (Change this immediately before deploying to a public environment).
• Database Name: nlink_db
  (The default schema created upon first boot).
• Exposed Port: 3306
  (Mapped to localhost to allow connections from external GUI tools like DBeaver or DataGrip).

Data Persistence (Volumes)

The mysql_data named volume maps strictly to /var/lib/mysql inside the container. If you prefer to bind the database directly to a physical folder on your host machine for easier backups, modify the volume syntax as follows:

    volumes:
      - ./my_database_backups:/var/lib/mysql