Skip to content
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

📝 Update manual installation #3229

Merged
merged 2 commits into from
Mar 2, 2023
Merged

📝 Update manual installation #3229

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
305c1c5
📝 updates manual installation doc
josemigallas Mar 2, 2023
47cb876
📝 updates recommended nodejs version
josemigallas Mar 2, 2023
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
2 changes: 1 addition & 1 deletion .tool-versions.sample
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
ruby 2.6.10
nodejs 10.19.0
nodejs 12.22.2
python 2.7.18
24 changes: 14 additions & 10 deletions fedora-manual-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ ln -s .tool-versions.sample .tool-versions

### Ruby and Node.js

The project supports **[ruby 2.6.x](https://www.ruby-lang.org/en/downloads/)** and **[Node.js 10](https://nodejs.org/en/download/)**.
The project supports **[ruby 2.6.x](https://www.ruby-lang.org/en/downloads/)** and **[Node.js 12](https://nodejs.org/en/download/)**.
The recommended way to install them is with `asdf`:

```
Expand All @@ -24,7 +24,7 @@ asdf install

> Alternatively, Node.js can be installed as a [Module](https://developer.fedoraproject.org/tech/languages/nodejs/nodejs.html):
> ```
> dnf module install nodejs:10
> dnf module install nodejs:12
> ```

### Dependencies
Expand All @@ -35,36 +35,40 @@ sudo dnf install sphinx chromedriver postgresql-devel mysql-devel ImageMagick I

### Database

The application requires a database that can either be [PostgreSQL](https://www.postgresql.org), [MySQL](https://www.mysql.com) or [Oracle database](https://www.oracle.com/database/). We recommend running MySQL in a [Podman](https://podman.io/) container:
The application requires a database that can either be [PostgreSQL](https://www.postgresql.org), [MySQL](https://www.mysql.com) or [Oracle database](https://www.oracle.com/database/). MySQL will be used by default.

###### MySQL

We recommend running it in a [Podman](https://podman.io/) container:

```sh
podman run -d -p 3306:3306 -e MYSQL_ALLOW_EMPTY_PASSWORD=true --name mysql57 mysql:5.7
```

### Redis

[Redis](https://redis.io) is an in-memory data store used as DB for some of the data and it has to be running for the application to work. We recommend running Redis in a [Podman](https://podman.io/) container:
[Redis](https://redis.io) is an in-memory data store used as DB for some of the data and it has to be running for the application to work. We recommend running it in a [Podman](https://podman.io/) container:

```
podman run -d -p 6379:6379 redis
```

Alternatively, it can be run directly on your machine with `dnf`:
Alternatively, Redis can be run directly on your machine with `dnf`:

```
sudo dnf install redis
sudo systemctl restart redis
```

### Rails cache (Memcached)
### Memcached

If available, Rails and Redis will use [Memcached](https://www.memcached.org) for caching. Installing it is completely optional but still recommended. We recommend running memcached in a [Podman](https://podman.io/) container:
If available, Rails will use [Memcached](https://www.memcached.org) for caching. Installing it is completely optional but still recommended. We recommend running it in a [Podman](https://podman.io/) container:

```
podman run -d -p 11211:11211 memcached
```

Alternatively, it can be installed directly on your machine:
Alternatively, Memcached can be run directly on your machine with `dnf`:

```
sudo dnf install memcached
Expand All @@ -80,7 +84,7 @@ sudo systemctl restart memcached

### Bundler

We manage Ruby gems with [Bundler](https://bundler.io/). Install it by running:
Ruby gems are managed with [Bundler](https://bundler.io/). Install it by running:

```
gem install bundler
Expand All @@ -100,7 +104,7 @@ bundle install

### Yarn (1.x)

To manage our JavaScript packages we use [Yarn](https://classic.yarnpkg.com/lang/en/). It is recommended to install it with NPM:
JavaScript packages are managed with [Yarn](https://classic.yarnpkg.com/lang/en/). It is recommended to install it with NPM:

```
npm install --global yarn
Expand Down
61 changes: 39 additions & 22 deletions osx-manual-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ ln -s .tool-versions.sample .tool-versions

### Ruby and Node.js

The project supports **[ruby 2.6.x](https://www.ruby-lang.org/en/downloads/)** and **[Node.js 10](https://nodejs.org/en/download/)**.
The recommended way to install them is with `asdf`:
The project supports **[ruby 2.6.x](https://www.ruby-lang.org/en/downloads/)** and **[Node.js 12](https://nodejs.org/en/download/)**. To install them with `asdf` run:

```
asdf plugin add ruby
Expand All @@ -39,12 +38,12 @@ asdf install
* **Macs with M1** require installing and running node through Rosetta 2:

```
arch -x86_64 asdf install nodejs 10.19.0
arch -x86_64 asdf install nodejs 12.22.2
```

### Python (only macs with M1)

The project requires Python 2.7.18. However, it is not included anymore in Apple macs with Silicon. We recommend to handle Python installation with `asdf`:
The project requires Python 2.7.18. However, it is not included anymore in Apple macs with Silicon. To install it with `asdf` run:

```
asdf plugin add python
Expand All @@ -65,60 +64,78 @@ xcode-select -—install
### Dependencies

```
brew install chromedriver imagemagick@6 gs pkg-config openssl geckodriver sphinx
brew install chromedriver imagemagick@6 gs pkg-config openssl geckodriver sphinx mysql@5.7 postgresql@14
brew link imagemagick@6
```

* **Macs with M1** also require de following:
* **Macs with M1** also require the following:
Copy link
Contributor

Choose a reason for hiding this comment

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

will you include heare the instructions to install local-fastimage_resize?
#3065 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Once the PR is verified and merged, yes


```
brew install pixman cairo pango
```

### Database
### Databases

The application requires a database that can either be [PostgreSQL](https://www.postgresql.org), [MySQL](https://www.mysql.com) or [Oracle database](https://www.oracle.com/database/). We recommend running MySQL in a [Docker](https://www.docker.com/) container:
The application requires a database that can either be [PostgreSQL](https://www.postgresql.org), [MySQL](https://www.mysql.com) or [Oracle database](https://www.oracle.com/database/). MySQL will be used by default.


###### MySQL

We recommend running it in a [Docker](https://www.docker.com/) container:

```sh
docker run -d -p 3306:3306 -e MYSQL_ALLOW_EMPTY_PASSWORD=true --name mysql57 mysql:5.7
```
* **Macs with M1** require the flag `--platform linux/x86_64`:

Alternatively, both MySQL and PostgreSQL can be installed and managed by Homebrew
```sh
# MySQL
brew install mysql@5.7
brew link mysql@5.7 --force
```
docker run -d -p 3306:3306 -e MYSQL_ALLOW_EMPTY_PASSWORD=true --name mysql57 --platform linux/x86_64 mysql:5.7
```

Alternatively it can be run by Homebrew:
```
brew services start mysql@5.7
```

###### PostgreSQL

We recommend running it in a [Docker](https://www.docker.com/) container:

```sh
export DATABASE_URL=postgresql://postgres:@localhost:5433/circleci

docker run -d -p 5433:5432 -e POSTGRES_USER=postgres -e POSTGRES_DB=circleci --name postgres10 circleci/postgres:10.5-alpine"
```

# PostgreSQL
brew install postgresql@14
Alternatively it can be run by Homebrew:
```
brew services start postgresql@14
```

### Redis

[Redis](https://redis.io) is an in-memory data store used as DB for some of the data and it has to be running for the application to work. We recommend running Redis in a [Docker](https://www.docker.com/) container:
[Redis](https://redis.io) is an in-memory data store used as DB for some of the data and it has to be running for the application to work. We recommend running it in a [Docker](https://www.docker.com/) container:

```
docker run -d -p 6379:6379 redis
```

Alternatively, it be run directly on your machine with Homebrew:
Alternatively, Redis can be run directly on your machine with Homebrew:

```
brew install redis
brew services start redis
```

### Rails cache (Memcached)
### Memcached

If available, Redis will use [Memcached](https://www.memcached.org) for caching. Installing it is completely optional but still recommended. We recommend running memcached in a [Docker](https://www.docker.com/) container:
If available, Rails will use [Memcached](https://www.memcached.org) for caching. Installing it is completely optional but still recommended. We recommend running it in a [Docker](https://www.docker.com/) container:

```
docker run -d -p 11211:11211 memcached
```

Alternatively, it can be run directly on your machine with Homebrew:
Alternatively, Memcached can be run directly on your machine with Homebrew:

```
brew install memcached
Expand All @@ -134,7 +151,7 @@ brew services start memcached

### Bundler

We manage Ruby gems with [Bundler](https://bundler.io/). Install it by running:
Ruby gems are managed with [Bundler](https://bundler.io/). Install it by running:

```
gem install bundler
Expand Down Expand Up @@ -170,7 +187,7 @@ bundle install

### Yarn (1.x)

To manage our JavaScript packages we use [Yarn](https://classic.yarnpkg.com/lang/en/). It is recommended to install it with NPM:
JavaScript packages are managed with [Yarn](https://classic.yarnpkg.com/lang/en/). Install it with NPM:

```
npm install --global yarn
Expand Down