Merge pull request #113 from cachix/importing

add importing from S3 documentation

source/faq.rst

@@ -34,7 +34,7 @@ If the entry exists:
     2. If you ran ``nix-build`` before binary cache has been populated,
        Nix will maintain a negative cache for the entry.
 
-       `See a workaround to remove negative caching <https://nix.dev/recipes/faq.html#how-do-i-force-nix-to-re-check-whether-something-exists-at-a-binary-cache>`_.
+       `See a workaround to remove negative caching <https://nix.dev/guides/faq.html#how-do-i-force-nix-to-re-check-whether-something-exists-at-a-binary-cache>`_.
 
     3. Substitution could be disabled for that derivation via ``allowSubstitutes = false;`` attribute.
 

source/getting-started.rst

@@ -1,3 +1,5 @@
+.. _getting-started:
+
 Getting Started
 ===============
 

source/importing-from-s3.rst

@@ -0,0 +1,64 @@
+Importing from S3
+=================
+
+.. versionadded:: 1.7
+
+Overview
+--------
+
+When transitioning to Cachix, it's common practice to migrate your existing binary caches. 
+
+This document outlines the procedure for importing a binary cache from an Amazon S3 bucket into Cachix. 
+
+This migration process is beneficial for managing garbage collection, implementing enhanced authentication schemes, and consolidating multiple binary caches.
+
+Prerequisites
+-------------
+
+- **AWS CLI**: The AWS Command Line Interface should be installed and configured on your system.
+- **Cachix**: Ensure that Cachix is installed. For instructions on installing Cachix, refer to the Getting Started with Cachix guide.
+
+Importing Cache from S3
+-----------------------
+
+The following steps outline the process of importing a binary cache from an S3 bucket:
+
+Step 1: Configure AWS Credentials
+*********************************
+
+Before proceeding, configure your AWS credentials:
+
+::
+
+    $ aws configure
+
+
+Follow the prompts to input your AWS Access Key ID, Secret Access Key, and default region.
+
+Step 2: Cachix Installation
+**********************************
+
+For installation instructions and verification, refer to the :ref:`Cachix getting started guide <getting-started>`.
+
+
+Step 3: Start the Import Process
+********************************
+
+To import the binary cache from your S3 bucket to Cachix, use the following command:
+
+Syntax::
+
+  $ cachix import <cache-name> s3://<bucket-name>
+
+
+Example::
+
+  $ cachix import mycache s3://mybucket
+
+
+Replace `<cache-name>` with your Cachix cache name and `<bucket-name>` with your S3 bucket name.
+
+Important Notes
+---------------
+
+- Data Streaming: All contents of the cache will be streamed through the machine executing the command. It is recommended to perform this operation on a machine with a fast network connection.

source/index.rst

@@ -18,6 +18,7 @@ Topics
    installation.rst
    getting-started.rst
    continuous-integration-setup/index.rst
+   importing-from-s3.rst
    deploy/index.rst
    pushing.rst
    garbage-collection.rst

source/installation.rst

@@ -7,7 +7,7 @@ Installation
 Recommended
 -----------
 
-With `Nix installed <https://nix.dev/tutorials/install-nix.html>`_::
+With `Nix installed <https://nix.dev/install-nix>`_::
 
     $ nix-env -iA cachix -f https://cachix.org/api/v1/install