Skip to content

Commit 8e3e84f

Browse files
committed
Improved installation instructions
Signed-off-by: Cédric Foellmi <cedric@onekiloparsec.dev>
1 parent f3ecf7d commit 8e3e84f

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

docs/local/installation.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Before proceeding with the installation, ensure that you have the following prer
1313
CPU, 2GB+ of RAM (depending on number of potential users). Moreover, for normal operations, outside any
1414
consideration of long-term data storage, Arcsecond requires at least 50GB of disk storage to operate. It is used for
1515
database backups, astrometry cache, temporary images data etc.
16-
- [Docker](https://docker.io) and [Docker Compose](https://docs.docker.com/compose/) installed on your PC.
16+
- [Docker](https://docker.io) is installed on your PC.
17+
- [pip](https://pip.pypa.io/en/stable/installation/) is installed on your PC (you can open a Terminal and type `pip3` to
18+
check first).
1719
- Access to the Arcsecond Docker private registry, via the personal authentication
1820
token (PAT). [Contact us](mailto:team@arcsecond.io) to obtain yours.
1921

@@ -25,13 +27,13 @@ any shell. On Windows, you should use the bash terminal coming with the installa
2527
the [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
2628
:::
2729

28-
- Create a directory where everything related to Arcsecond will be stored, and go inside it.
29-
- Install the Arcsecond CLI: `pip3 install arcsecond`. You can verify that the installation was successful by running
30-
`arcsecond --version`.
31-
- Decide in which folder the data that Arcsecond is generating will be stored.
32-
- Run the basic setup: `arcsecond setup` and provide the above folder path.
33-
- You can check that you have a `.env` file containing some secret keys, and a file `docker-compose.yml` with the
34-
Arcsecond system configuration.
30+
- Open the Terminal.
31+
- Install the Arcsecond CLI: `pip3 install arcsecond`.
32+
- Verify the installation was successful by running `arcsecond --version`.
33+
- Create a directory where everything related to Arcsecond will be stored, and go inside it, with the terminal.
34+
- Run the basic setup: `arcsecond setup`.
35+
- You can check that you have a new `.env` file in the current directory, containing some secret keys.
36+
- You should also have a file named `docker-compose.yml` with the Arcsecond system configuration.
3537
- Have your PAT with you, and login once in the Arcsecond Docker registry (replace `<PAT>` with your PAT):
3638
`echo <PAT> | docker login ghcr.io -u arcsecond-io --password-stdin`
3739
- You can now start Arcsecond.local with the command: `docker compose up -d`. **The first time, Docker will download all

0 commit comments

Comments
 (0)