Skip to content

Commit

Permalink
Update Docker image repository in self-hosting guide (#70)
Browse files Browse the repository at this point in the history
* Update Docker image repository in self-hosting guide

* Update Docker image tags for self-hosting
  • Loading branch information
Tyrrrz authored Dec 22, 2023
1 parent 3fe9772 commit 0bae153
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
12 changes: 10 additions & 2 deletions src/guide/self-hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ storing the generated configuration file and database. Otherwise, the database a
To get up and running, execute the lines below.

```bash
docker pull ghcr.io/passwordless/passwordless-self-host
docker pull bitwarden/passwordless-self-host:stable
docker run \
--publish 5701:5701 \
--volume {your-host-directory}:/etc/bitwarden_passwordless \
ghcr.io/passwordless/passwordless-self-host
bitwarden/passwordless-self-host:stable
```

You should now be able to access your own `Passwordless.dev` instance at:
Expand Down Expand Up @@ -68,6 +68,14 @@ For Api:
docker exec -it {name-of-container} cat /app/Api/mail.md
```

## Available Tags

- `stable` - built from the latest stable version release (recommended)
- `1.0.55` - built from a specific stable version release
- `latest` - built from the current state of the `main` branch

For more information, please see the [Docker Hub](https://hub.docker.com/r/bitwarden/passwordless-self-host/tags) page.

## Known Issues

- There is no active sync between self-hosted Admin Console and the cloud hosted [Admin Console](https://admin.passwordless.dev).
Expand Down
4 changes: 2 additions & 2 deletions src/guide/self-hosting/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Failure to mount persistent storage, will:
$ docker run -d \
--name passwordless \
--mount source=/your/persistent/storage,target=/etc/bitwarden_passwordless \
ghcr.io/passwordless/passwordless-self-host:latest
bitwarden/passwordless-self-host:stable
```

## Database
Expand Down Expand Up @@ -142,5 +142,5 @@ If the following keys do not exist, they will be generated automatically:
- PasswordlessManagement::ManagementKey
- SALT_KEY

It is recommended that you have them generated automatically, the first time you run `ghcr.io/passwordless/passwordless-self-host`.
It is recommended that you have them generated automatically, the first time you run `bitwarden/passwordless-self-host`.
```
12 changes: 6 additions & 6 deletions src/guide/self-hosting/running-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
- No permanent storage: In this example, the generated `config.json` and `Sqlite databases` will be lost.

```bash
docker pull ghcr.io/passwordless/passwordless-self-host
docker pull bitwarden/passwordless-self-host:stable
docker run \
--publish 5042:5701 \
--env BWP_ENABLE_SSL=true \
ghcr.io/passwordless/passwordless-self-host
bitwarden/passwordless-self-host:stable
```

## Simple example #2
Expand All @@ -19,12 +19,12 @@ docker run \
- Permanent storage: In this example, the generated `config.json` and `Sqlite databases` will be retained on the host in directory `/your/directory`.

```bash
docker pull ghcr.io/passwordless/passwordless-self-host
docker pull bitwarden/passwordless-self-host:stable
docker run \
--publish 5042:5701 \
--volume /your/directory:/etc/bitwarden_passwordless \
--env BWP_PORT=5042 \
ghcr.io/passwordless/passwordless-self-host
bitwarden/passwordless-self-host:stable
```

## Example with SSL
Expand All @@ -33,13 +33,13 @@ docker run \
- Permanent storage: In this example, the generated `config.json` and `Sqlite databases` will be retained on the host in directory `/your/directory`.

```bash
docker pull ghcr.io/passwordless/passwordless-self-host
docker pull bitwarden/passwordless-self-host:stable
docker run \
--publish 5042:5701 \
--volume /your/directory:/etc/bitwarden_passwordless \
--env BWP_PORT=5042 \
--env BWP_ENABLE_SSL=true \
ghcr.io/passwordless/passwordless-self-host
bitwarden/passwordless-self-host:stable
```

:::warning
Expand Down

0 comments on commit 0bae153

Please sign in to comment.