Laravel Sail Up - invalid Group Id & Permissions on created files

The issue you're encountering with file permissions and group IDs in Laravel Sail on an Ubuntu 22 machine is a common one when dealing with Docker containers. Here’s a step-by-step solution to address the problem:

Step 1: Verify User and Group IDs

First, ensure that the user and group IDs you are using in your .env file are correct and do not conflict with existing IDs on your host system.

You can check your current user and group IDs with the following commands:

id -u
id -g

These commands will output your user ID (UID) and group ID (GID). Make sure these IDs match the WWWUSER and WWWGROUP values in your .env file.

Step 2: Update Dockerfile

If the IDs are correct, you might need to adjust the Dockerfile used by Laravel Sail to ensure it correctly sets the user and group. You can customize the Dockerfile by copying it from the Sail package to your project directory and modifying it.

1. Copy the Dockerfile from the Sail package:

cp vendor/laravel/sail/runtimes/8.2/Dockerfile Dockerfile

1. Open the copied Dockerfile and modify the groupadd and useradd commands to ensure they use the correct IDs:

# Dockerfile

# Add the group and user with the specified IDs
RUN groupadd --force -g ${WWWGROUP} sail \
    && useradd -ms /bin/bash --no-user-group -g ${WWWGROUP} -u ${WWWUSER} sail

Step 3: Update docker-compose.yml

Ensure your docker-compose.yml file correctly passes the environment variables to the build context:

# docker-compose.yml

version: '3'
services:
  laravel.test:
    build:
      context: .
      dockerfile: Dockerfile
      args:
        WWWGROUP: '${WWWGROUP}'
        WWWUSER: '${WWWUSER}'
    image: sail-8.2/app
    extra_hosts:
      - 'host.docker.internal:host-gateway'
    ports:
      - '${APP_PORT:-80}:80'
      - '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
    environment:
      WWWUSER: '${WWWUSER}'
      LARAVEL_SAIL: 1
      XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-debug}'
      XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
    volumes:
      - '.:/var/www/html'
    networks:
      - sail
    depends_on:
      - mysql
      - phpmyadmin
  mysql:
    image: 'mysql/mysql-server:8.0'
    ports:
      - '${FORWARD_DB_PORT:-3306}:3306'
    environment:
      MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
      MYSQL_ROOT_HOST: "%"
      MYSQL_DATABASE: '${DB_DATABASE}'
      MYSQL_USER: '${DB_USERNAME}'
      MYSQL_PASSWORD: '${DB_PASSWORD}'
      MYSQL_ALLOW_EMPTY_PASSWORD: 1
    volumes:
      - 'sail-mysql:/var/lib/mysql'
      - './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
    networks:
      - sail
    healthcheck:
      test: [ "CMD", "mysqladmin", "ping", "-p${DB_PASSWORD}" ]
      retries: 3
      timeout: 5s
  phpmyadmin:
    image: 'phpmyadmin:latest'
    ports:
      - 8080:80
    networks:
      - sail
    environment:
      - PMA_ARBITRARY=1
networks:
  sail:
    driver: bridge
volumes:
  sail-mysql:
    driver: local

Step 4: Rebuild and Start Sail

After making these changes, rebuild your Docker images and start Sail:

./vendor/bin/sail build --no-cache
./vendor/bin/sail up

Step 5: Fix Existing File Permissions

To fix the permissions of existing files, you can run the following commands on your host machine:

sudo chown -R $USER:$USER .

This command will recursively change the ownership of all files in your project directory to your current user and group.

Conclusion

By ensuring the correct user and group IDs are used and properly configuring the Dockerfile and docker-compose.yml, you should be able to resolve the permission issues you're experiencing with Laravel Sail on your Ubuntu 22 machine.