Skip to content

Commit aa51ff7

Browse files
committed
docs: be more explicit on when the ./rhn directory is needed
Signed-off-by: Avi Miller <[email protected]>
1 parent 32528b8 commit aa51ff7

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ For the best sync performance, add repos from the Oracle Linux yum server wherev
2222

2323
### Register with ULN (optional)
2424

25-
Before content can be synced from ULN, the container has to be registered. The following command will map the local `rhn/` directory to `/etc/sysconfig/rhn/` inside the container and then automatically register the container using the ULN credentials provided in `config/uln.conf`:
25+
Before content can be synced from ULN, the container has to be registered. First, create a directory named `rhn` then run the following command.
26+
27+
This command maps the `rhn/` directory to `/etc/sysconfig/rhn/` inside the container then automatically registers the container using the ULN credentials provided in `config/uln.conf` (check the section on [storing ULN credentials](#store-uln-credentials) for more detail):
2628

2729
```bash
2830
docker run --rm -it \
@@ -32,7 +34,9 @@ docker run --rm -it \
3234
ghcr.io/djelibeybi/ol-repo-sync register
3335
```
3436

35-
This will take a few minutes with no output to the terminal but should return to the command prompt when completed.
37+
This will take a few minutes with no output to the terminal but should return to the command prompt when completed.
38+
39+
> If you don't sync from ULN, remove `-v "$PWD/rhn:/etc/sysconfig/rhn" \` from the command.
3640
3741
If you mount a local directory to `/etc/sysconfig/rhn` each time you start a container, you should only have to register with ULN once, as the registration details are stored inside this directory.
3842

@@ -72,12 +76,14 @@ The following command will sync the content of the repos configured in `config/r
7276
```bash
7377
docker run --rm -it \
7478
--name ol-repo-sync \
75-
-v "$PWD/rhn:/etc/sysconfig/rhn" \
79+
-v "$PWD/rhn:/etc/sysconfig/rhn" \ # only required for ULN
7680
-v "$PWD/config:/config" \
7781
-v "$PWD/repo:/repo" \
7882
ghcr.io/djelibeybi/ol-repo-sync
7983
```
8084

85+
> If you are not syncing from ULN, remove `-v "$PWD/rhn:/etc/sysconfig/rhn" \` from the command.
86+
8187
For each `yum` or `uln` source configured in `config/repos.json`, the sync process will:
8288

8389
1. Enable the repo (`yum`) or subscribe to the channel (`uln`).

0 commit comments

Comments
 (0)