Skip to content

Add notes to make it obvious how to install Sqlite support #591

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add notes to make it obvious how to install Sqlite support #591

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21ed118
Add notes to make it obvious how to get Sqlite support
mikeschinkel Jun 7, 2021
07b4326
Removed redundant Sqlite notice for Chocolatey
mikeschinkel Jun 7, 2021
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
13 changes: 8 additions & 5 deletions templates/en/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Again, if you don't need a database, you won't need these.
## Installation from a release archive - 64 bits

<%= note() { %>
The release packages contain Buffalo without SQLite support.
The release packages contain Buffalo without SQLite support. For SQLite support use a [custom installation](#custom-installation-with-sqlite3-support).
<% } %>

Since `v0.10.3`, pre-compiled archives are provided with each release. If you don't need the latest cutting-edge version, you'll probably prefer to install this version.
Expand All @@ -50,6 +50,7 @@ $ wget https://github.com/gobuffalo/buffalo/releases/download/v<%= version %>/bu
$ tar -xvzf buffalo_<%= version %>_Linux_x86_64.tar.gz
$ sudo mv buffalo /usr/local/bin/buffalo
```
If you need Sqlite support use a [custom installation](#custom-installation-with-sqlite3-support).

### MacOS

Expand All @@ -60,24 +61,25 @@ $ sudo mv buffalo /usr/local/bin/buffalo
# or if you have ~/bin folder setup in the environment PATH variable
$ mv buffalo ~/bin/buffalo
```
If you need Sqlite support use a [custom installation](#custom-installation-with-sqlite3-support).

## Scoop (Windows)
Buffalo can be installed using the [Scoop](http://scoop.sh/) package manager:
Buffalo can be installed _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ using the [Scoop](http://scoop.sh/) package manager:

```powershell
PS C:\> scoop install buffalo
```

## Chocolatey (Windows)
Buffalo can be installed using the [Chocolatey](https://chocolatey.org/packages/buffalo) package manager. Versions on Chocolatey are published with a potential delay and must go through moderation before they are available:
Buffalo can be installed _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ using the [Chocolatey](https://chocolatey.org/packages/buffalo) package manager. Versions on Chocolatey are published with a potential delay and must go through moderation before they are available:

```powershell
PS C:\> choco install buffalo
```

## Homebrew (macOS)

On macOS, you can also install Buffalo with [Homebrew](https://brew.sh/). After you have Homebrew [installed](https://docs.brew.sh/Installation), you can easily install Buffalo:
On macOS, you can also install Buffalo _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ using [Homebrew](https://brew.sh/). After you have Homebrew [installed](https://docs.brew.sh/Installation), you can easily install Buffalo:

```bash
brew install gobuffalo/tap/buffalo
Expand All @@ -87,14 +89,15 @@ brew install gobuffalo/tap/buffalo

[GoFish](https://gofi.sh/index.html) is a cross-platform systems package manager, that works across Windows, MacOSX and Linux.

After you have GoFish [installed](https://gofi.sh/index.html#install), you can very simply install Buffalo:
After you have GoFish [installed](https://gofi.sh/index.html#install), you can install Buffalo _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ very simply with:

```bash
$ gofish install buffalo
==> Installing buffalo...
🐠 buffalo <%= version %>: installed in 3.223672926s
```


## Custom installation **with** SQLite3 Support

**SQLite 3** requires a GCC, or equivalent C compiler for [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) to compile. You **must** have a GCC installed **first** before installing Buffalo.
Expand Down