docs: add requirements per thread section, add examples for mounts on different OS

This commit is contained in:
Tha_14 2023-01-24 01:05:21 +02:00 committed by GitHub
parent 98e32ecc26
commit c9d8dbc1c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,7 +6,7 @@
### Single UAM instance
1. Make sure you have docker and docker-compose installed on your host.
2. Clone this repository.
3. If you're on windows or macos, in the docker-compose.yml file, make sure you change the volume path `/opt/uam_data` to something that works on your OS.
3. If you're on windows or macos, in the docker-compose.yml file, make sure you change the volume path `/opt/uam_data` to something that works on your OS. For example: on Windows something like `c/uam_data`, on macOS `${HOME}/uam_data`.
4. Execute the following command in terminal while being in the `uam` directory of this repository:
```PBKEY={YOURKEYHERE} docker-compose up -d```
@ -14,7 +14,7 @@
### UAM Swarm
1. Make sure you have docker and docker-compose installed on your host.
2. Clone this repository.
3. If you're on windows or macos, in the docker-compose.yml file, make sure you change the volume path `/opt/uam_data/uam_` to something that works on your OS.
3. If you're on windows or macos, in the docker-compose.yml file, make sure you change the volume path `/opt/uam_data/uam_` to something that works on your OS. For example: on Windows something like `c/uam_data/uam_`, on macOS `${HOME}/uam_data/uam_`.
4. Optionally, add or remove services according to your needs. You can copy and paste the existing services and incement the names, paths, and ports for each of them.
5. Execute the following command in terminal while being in the `uam-swarm` directory of this repository:
@ -28,3 +28,9 @@
5. I suggest using [lazydocker](https://github.com/jesseduffield/lazydocker) to control and see the status of your containers.
6. You can disable wondershaper(traffic shaping) if you're experiencing problems by setting `ENABLE_WONDERSHAPER` to `false`.
## Requirements per thread:
* 4300MB free ram RAM
* 4 CPU cores
* 10Mbps upload and download bandwidth
* 100MB disk space
* 32CRP held in your wallet or delegated to you