Skip to content

SWIFT-696 Update installation instructions to mention required system libraries #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 18, 2020
Merged

SWIFT-696 Update installation instructions to mention required system libraries #405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbd612e
remove libmongoc installation from examples and readme
patrickfreed Feb 14, 2020
41ca275
update issue template
patrickfreed Feb 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ What does this command give you?
```
$ cat Package.resolved # Applies if you are using Swift package manager
```
*or*
```
$ cat Podfile.lock # Applies if you are using Cocoapods
```


### What is the version(s) of `mongod` that you are running with the driver?
Expand All @@ -53,28 +49,6 @@ or, running this in a MongoDB shell connected to the relevant node(s):
How is your MongoDB deployment configured?


### How did you install `libmongoc` and `libbson` on your system

Did you use `brew`? Did you install them manually? etc.


### Version of `libmongoc` and `libbson`

What does this command give you?
```
$ brew list --versions mongo-c-driver # Applies if you installed via brew
```
*or*
```
$ apt list --installed | grep -E '(libmongoc|libbson)' # Applies if you installed via apt
```
*or*
```
$ pkg-config --modversion libmongoc-1.0 # Applies if you use pkg-config
$ pkg-config --modversion libbson-1.0
```


## What is the problem?

**BE SPECIFIC**:
Expand Down
14 changes: 0 additions & 14 deletions Examples/Docker/Dockerfile
View file
Open in desktop

This file was deleted.

65 changes: 0 additions & 65 deletions Examples/Docker/Dockerfile.vapor
View file
Open in desktop

This file was deleted.

34 changes: 0 additions & 34 deletions Examples/Docker/README.md
View file
Open in desktop

This file was deleted.

13 changes: 3 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,12 @@ Core Server (i.e. SERVER) project are **public**.

Installation is supported via [Swift Package Manager](https://swift.org/package-manager/).

### Step 1: Install the MongoDB C Driver
The driver wraps the MongoDB C driver, and using it requires having the C driver's two components, `libbson` and `libmongoc`, installed on your system. **The minimum required version of the C Driver is 1.15.3**.
### Step 1: Install required system libraries (Linux Only)
Copy link
Contributor Author

@patrickfreed patrickfreed Feb 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

libmongoc only lists dependencies for linux, since I think the tls stuff is built into SecureTransport and macos appears to ship with sasl2.

The driver vendors and wraps the MongoDB C driver (`libmongoc`), which depends on a number of external C libraries when built in Linux environments. As a result, these libraries must be installed on your system in order to build MongoSwift.
Copy link
Contributor Author

@patrickfreed patrickfreed Feb 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I decided to just keep relying on libmongoc's instructions so that we don't have to update this all the time. The one caveat with that is that it includes cmake as a dependency, which isn't necessary for us. That doesn't seem like too big of a deal to me though.


*On a Mac*, you can install both components at once using [Homebrew](https://brew.sh/):
`brew install mongo-c-driver`.

*On Linux*: please follow the [instructions](http://mongoc.org/libmongoc/current/installing.html#building-on-unix) from `libmongoc`'s documentation. Note that the versions provided by your package manager may be too old, in which case you can follow the instructions for building and installing from source.

See example installation from source on Ubuntu in [Docker](https://github.com/mongodb/mongo-swift-driver/tree/master/Examples/Docker).
To install those libraries, please follow the [instructions](http://mongoc.org/libmongoc/current/installing.html#prerequisites-for-libmongoc) from `libmongoc`'s documentation.

### Step 2: Install MongoSwift
*Please follow the instructions in the previous section on installing the MongoDB C Driver before proceeding.*

Add MongoSwift to your dependencies in `Package.swift`:

```swift
Expand Down