Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
thedavidmeister committed Jan 9, 2024
1 parent 65edff7 commit 9f91ce4
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,20 +97,32 @@ 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 <command>
git clone [email protected]:gildlab/ipfs-node.git
cd ipfs-node
nix-shell
```

Where `<command>` 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

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.
Expand All @@ -125,4 +137,8 @@ This needs to be run whenever config/peerlist/etc. changes so that the changes t
2. htpasswd -nbB -C 10 <username> <password>

This will provide hashed (bcrypt) version of the password with username in a
format that is compatible with nginx.
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.

0 comments on commit 9f91ce4

Please sign in to comment.