Skip to content

Commit dbf1c75

Browse files
authored
Clarify running options
1 parent dd764b0 commit dbf1c75

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

server/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -77,26 +77,33 @@ https://user-images.githubusercontent.com/2183313/139728539-d69b899f-6f9b-44cb-a
7777

7878
## Installation & getting started
7979

80-
You can run `atomic-server` in four ways:
80+
You can run `atomic-server` in five ways:
8181

82-
- From a published [binary](https://github.com/joepio/atomic/releases) (probably the quickest)
83-
- Using docker
84-
- Install a desktop build (macOS only as of now)
85-
- Using [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) from crates.io: `cargo install atomic-server`
86-
- Manually from source
82+
1. Using docker (probably the quickest): `docker run -p 80:80 -p 443:443 -v atomic-storage:/atomic-storage joepmeneer/atomic-server`
83+
2. Install a desktop build (macOS only as of now)
84+
3. From a published [binary](https://github.com/joepio/atomic/releases)
85+
4. Using [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) from crates.io: `cargo install atomic-server`
86+
5. Manually from source
8787

8888
When you're running `atomic-server`, go to [Initial setup and configuration](#Initial-setup-and-configuration).
8989
If you want to run this locally as a developer / contributor, check out [the Contributors guide](../CONTRIBUTE.md).
9090

91-
## Install desktop build (macOS only)
91+
### 1. Run using docker
92+
93+
- Run: `docker run -p 80:80 -p 443:443 -v atomic-storage:/atomic-storage joepmeneer/atomic-server`
94+
The `dockerfile` is located in the project root, above this `server` folder.
95+
- If you want to make changes (e.g. to the port), make sure to pass the relevant CLI options (e.g. `--port 9883`).
96+
- If you want to update, run `docker pull joepmeneer/atomic-server` and docker should fetch the latest version.
97+
98+
### 2. Install desktop build (macOS only)
9299

93100
We automatically build `.dmg` installers for MacOS. You can download them from the [releases page](https://github.com/atomicdata-dev/atomic-data-rust/releases).
94101

95-
### Run pre-compiled binary
102+
### 3. Run pre-compiled binary
96103

97104
Get the binaries from the [releases page](https://github.com/atomicdata-dev/atomic-data-rust/releases) and copy them to your `bin` folder.
98105

99-
### Install using cargo
106+
### 4. Install using cargo
100107

101108
```sh
102109
# Install from source using cargo, and add it to your path
@@ -108,22 +115,15 @@ atomic-server --help
108115
atomic-server
109116
```
110117

111-
### Run using docker
112-
113-
- Run: `docker run -p 80:80 -p 443:443 -v atomic-storage:/atomic-storage joepmeneer/atomic-server`
114-
The `dockerfile` is located in the project root, above this `server` folder.
115-
- If you want to make changes (e.g. to the port), make sure to pass the relevant CLI options (e.g. `--port 9883`).
116-
- If you want to update, run `docker pull joepmeneer/atomic-server` and docker should fetch the latest version.
117-
118-
### Run from source
118+
### 5. Compile from source
119119

120120
```sh
121121
git clone git@github.com:joepio/atomic-data-rust.git
122122
cd atomic-data-rust/server
123123
cargo run
124124
```
125125

126-
### Troubleshooting compiling from source:
126+
If things go wrong while compiling from source:
127127

128128
```sh
129129
# If cc-linker, pkg-config or libssl-dev is not installed, make sure to install them

0 commit comments

Comments
 (0)