Skip to content

Commit

Permalink
Adding installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
costrouc committed Aug 17, 2022
1 parent 5a2bebf commit 6482fc4
Showing 1 changed file with 30 additions and 6 deletions.
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,36 @@

![conda-store UI](docs/_static/images/conda-store-authenticated.png)

## Documentation

All documentation can be found on Read the Docs including how to develop
and contribute to the
project. [conda-store.readthedocs.io](https://conda-store.readthedocs.io).

## Installation

`conda-store` has two packages a `conda-store` (the client) and
`conda-store-server` (the server). Make sure that either `conda` or
`mamba` are in your path.

```shell
conda install -c conda-forge conda-store-server conda-store
```

The `conda-store` server can be easily launched in standalone mode
that carries no dependencies on databases, object storage, redis.

```
conda-store-server --standalone
```

Standalone mode runs all components together to simplify
deployment. For more complex and scalable setups there are
[installation examples for containerized and distributed
environments](docs/installation.md).

## Motivation

End users think in terms of environments not packages. The core
philosophy of conda-store is to serve identical Conda environments in
as many ways as possible. conda-store controls the environment
Expand All @@ -42,12 +72,6 @@ and a docker registry. Tarballs and Docker images can carry a lot of
bandwidth which is why conda-store integrates optionally with `s3` to
actually serve the blobs.

## Documentation

All documentation can be found on Read the Docs including how to develop
and contribute to the
project. [conda-store.readthedocs.io](https://conda-store.readthedocs.io).

## Terminology

- A `namespace` is a way of scoping environments
Expand Down

0 comments on commit 6482fc4

Please sign in to comment.