From patchwork Tue Jun 22 08:13:02 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Axtens X-Patchwork-Id: 1495485 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.ozlabs.org (client-ip=112.213.38.117; helo=lists.ozlabs.org; envelope-from=patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org; receiver=) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=axtens.net header.i=@axtens.net header.a=rsa-sha256 header.s=google header.b=iWh4jmhq; dkim-atps=neutral Received: from lists.ozlabs.org (lists.ozlabs.org [112.213.38.117]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4G8K0K3ghlz9sW7 for ; Tue, 22 Jun 2021 18:13:21 +1000 (AEST) Received: from boromir.ozlabs.org (localhost [IPv6:::1]) by lists.ozlabs.org (Postfix) with ESMTP id 4G8K0K1GYzz302G for ; Tue, 22 Jun 2021 18:13:21 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=axtens.net header.i=@axtens.net header.a=rsa-sha256 header.s=google header.b=iWh4jmhq; dkim-atps=neutral X-Original-To: patchwork@lists.ozlabs.org Delivered-To: patchwork@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=axtens.net (client-ip=2607:f8b0:4864:20::102f; helo=mail-pj1-x102f.google.com; envelope-from=dja@axtens.net; receiver=) Authentication-Results: lists.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=axtens.net header.i=@axtens.net header.a=rsa-sha256 header.s=google header.b=iWh4jmhq; dkim-atps=neutral Received: from mail-pj1-x102f.google.com (mail-pj1-x102f.google.com [IPv6:2607:f8b0:4864:20::102f]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 4G8K0C3xP7z2ykQ for ; Tue, 22 Jun 2021 18:13:13 +1000 (AEST) Received: by mail-pj1-x102f.google.com with SMTP id 13-20020a17090a08cdb029016eed209ca4so1794813pjn.1 for ; Tue, 22 Jun 2021 01:13:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=axtens.net; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=RYWov4YHmApAyW80D+XbBI4rOMNCxRU4UFhc59xlZhk=; b=iWh4jmhqYr5yEfYT6lttw0zQ+nsY38cFISXSLfFQhbV8lReL0oHv5kL0LqXbnIRyWR K8AG7FGnxGSIy9XYye8gOvxe5JRZx2VHAfqxr7+C4eUZHHd3xjNcR47hUtOV22M2XvWw dV8qJDq9alLwVeu/ZJTI/H5lQLhhcr5W4yIcQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=RYWov4YHmApAyW80D+XbBI4rOMNCxRU4UFhc59xlZhk=; b=DnEKu7KXs70Hr9mV49NeVBc4HmzmnTG1+q/5WmmGoQt/lgV5AwB+s7FIpmRTT5eT7s IRzf3NIAGU4lxSFJ3b/NdHjkUqUnKub2ZQH11YCJhyLixjC1QIYftkLv411Z6s3e3cC0 ISYgR8IrsXTBFb79vSHpcX3Oe1ZCdurqe2gKRRmI3z1YwUPYx7i/X22/XYnESBVfGiuP xoUiycLitvehe6QS+xTMdzv2GDsfDQdIHqGule1ndTUmIVFcRnA8ij+1t+fWyr+X9Aui P1GoAuMgOcZJCLNP8F5QeMCbRYRh4e7R7Uf2UwTgln+pIrueJAIMo0vjgwExZoMRMApp 0FMQ== X-Gm-Message-State: AOAM533FTlnFsMju7Ia9ZVc6to9W6xqJmSUWF3Jf1gQqcFxrebrCJ7ee GFREoFs3k1FiD587LbY/tLVMeXL5Ar9WIw== X-Google-Smtp-Source: ABdhPJyWj0yyUiowukgwbmSq1G60KJ3FioEOiwUqvsdk1ENOe+7caIqCsRm31H0eMy1Lyr3ss4r+Wg== X-Received: by 2002:a17:90a:a395:: with SMTP id x21mr2579324pjp.63.1624349588662; Tue, 22 Jun 2021 01:13:08 -0700 (PDT) Received: from localhost ([203.206.29.204]) by smtp.gmail.com with ESMTPSA id o7sm20039175pgs.45.2021.06.22.01.13.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 22 Jun 2021 01:13:08 -0700 (PDT) From: Daniel Axtens To: patchwork@lists.ozlabs.org Subject: [PATCH] docs: clarify and improve docker dev docs Date: Tue, 22 Jun 2021 18:13:02 +1000 Message-Id: <20210622081302.69989-1-dja@axtens.net> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 X-BeenThere: patchwork@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Patchwork development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Patchwork" The docker dev docs: - had the links for docker and docker-compose swapped. - had a old docker install link. - lacked an up-front explanation of the requirement that a regular user be able to manage the docker daemon (and a fairly unhelpful reference link in the most appropriate note block.) Fix it all. Reported-by: Emily Shaffer Signed-off-by: Daniel Axtens --- docs/development/installation.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/development/installation.rst b/docs/development/installation.rst index ff81229dfbd9..1dc917e0d67d 100644 --- a/docs/development/installation.rst +++ b/docs/development/installation.rst @@ -22,7 +22,12 @@ Patchwork provides a Docker-based environment for quick configuration of a development environment. This is the preferred installation method. To configure Patchwork using Docker: -#. Install `docker`_ and `docker-compose`_. +#. Install `docker`_ and `docker-compose`_. [1]_ Patchwork assumes that you + have Docker configured to allow a non-root user to manage Docker, as + outlined in the `Docker post-install instructions `_. + + .. [1] Depending on your distro, `docker-compose` may also be available as a + package. #. Create a ``.env`` file in the root directory of the project and store your ``UID`` and ``GID`` attribute there. @@ -125,9 +130,8 @@ For more information on Docker itself, please refer to the `docker`_ and ERROR: Couldn't connect to the Docker daemon at http+docker://localunixsocket - is it running? - ensure you have correctly installed Docker, added your user to the - ``docker`` group, and started the daemon, per the `docker documentation - `_. + ensure you have correctly installed Docker, and have followed the `Docker + post-install instructions `_. .. note:: @@ -141,8 +145,9 @@ For more information on Docker itself, please refer to the `docker`_ and __ https://github.com/docker/compose/issues/2380 -.. _docker: https://docs.docker.com/compose/install/ -.. _docker-compose: https://docs.docker.com/engine/installation/linux/ +.. _docker: https://docs.docker.com/engine/install/ +.. _docker-compose: https://docs.docker.com/compose/install/ +.. _post-install: https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user Manual Installation