Skip to content

Commit

Permalink
Document how to do a clean install
Browse files Browse the repository at this point in the history
Fixes #2311

Signed-off-by: Carolyn Van Slyck <[email protected]>
  • Loading branch information
carolynvs committed Sep 2, 2022
1 parent 1b74eb6 commit e48a077
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/content/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ description: Installing the Porter client and mixins
Porter is about to release v1.0.0, and we strongly recommend that you install that version of Porter if you are just starting out.

* [Install Porter v1](#recommended)
* [Clean Install](#clean-install)

If you are already using Porter, here are links to install an older v0 version of Porter.
Heads up that v0 will be deprecated a few months after v1.0.0 is released!
Expand Down Expand Up @@ -87,6 +88,21 @@ porter version
[mailing list]: https://groups.io/g/porter
[Slack]: /community/#slack

# Clean Install

To perform a clean installation of Porter:

1. Remove the PORTER_HOME directory, which by default is located at `~/.porter`.
2. Start over with a fresh database. If you were using an external database, update your porter configuration file to use a different database.

Otherwise, if you had not specified a storage plugin or database in the configuration file, then your database is located in a container in Docker.
Remove the mongodb container and volume, so that when Porter is run again, it creates a new database:
```
docker rm -f porter-mongodb-docker-plugin
docker volume rm porter-mongodb-docker-plugin-data
```
3. Install Porter following the instructions on this page.

# Latest

Install the most recent stable v0 release of porter and the [exec mixin].
Expand Down
10 changes: 10 additions & 0 deletions docs/content/plugins/mongodb-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,13 @@ default-storage = "mymongo"
### port

The port parameter configures which port the MongoDB server listens on. By default, this plugin listens on 27018.


## Remove Plugin Data

If you want to do a fresh installation of Porter and start over with a new database, run the following commands to remove the container and volume used by the plugin.

```
docker rm -f porter-mongodb-docker-plugin
docker volume rm porter-mongodb-docker-plugin-data
```

0 comments on commit e48a077

Please sign in to comment.