From 9f91ce4f0f0acd6cdb009fb84af5df54f73896b4 Mon Sep 17 00:00:00 2001 From: thedavidmeister Date: Tue, 9 Jan 2024 20:20:11 +0400 Subject: [PATCH] readme update --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3601bb8..b7542d9 100644 --- a/README.md +++ b/README.md @@ -97,13 +97,17 @@ You may need to restart the machine for these changes to take effect. ### Enter the nix shell for this repository -Once you have nix and docker installed you can run nix shell commands straight from github. +Once you have nix and docker installed you can run nix shell commands from this repo. + +First clone the repo from github, then run `nix-shell` from inside it. ``` -nix-shell https://abc.gildlab.xyz?$RANDOM --run +git clone git@github.com:gildlab/ipfs-node.git +cd ipfs-node +nix-shell ``` -Where `` is whatever command you want to run. +Now you should be inside a nix shell, which allows you to run the `gl-*` commands. #### Setup config @@ -111,6 +115,14 @@ Run `gl-config-edit` in nix shell to setup config for your environment. `GILDLAB_IPFS_NODE_CHANNEL` : Set the channel (github branch) to either `main` or `develop`. Default is `main` if not set. +The config file is `.env` style, using the `export` keyword for variables. + +E.g. Your config file should look like: + +``` +export GILDLAB_IPFS_NODE_CHANNEL=develop +``` + #### (Re)start the docker Run `gl-docker-start` in nix shell to (re)boot all the boxes. @@ -125,4 +137,8 @@ This needs to be run whenever config/peerlist/etc. changes so that the changes t 2. htpasswd -nbB -C 10 This will provide hashed (bcrypt) version of the password with username in a -format that is compatible with nginx. \ No newline at end of file +format that is compatible with nginx. + +Note that this uses `nix develop` rather than `nix-shell` as it uses the flake +instead of the `default.nix` file. The nix shell way of doing things is +deprecated, so things will be moved to `nix develop` over time. \ No newline at end of file