Commit a2d504da authored by Mike Jang's avatar Mike Jang

Merge branch 'khughes-update-rails-runner-example' into 'master'

Docs: add rails runner example

Closes #214020

See merge request gitlab-org/gitlab!29353
parents 2d931635 47c3a9a7
...@@ -62,8 +62,8 @@ puts Readline::HISTORY.to_a ...@@ -62,8 +62,8 @@ puts Readline::HISTORY.to_a
## Using the Rails Runner ## Using the Rails Runner
If you need to run some Ruby code in thex context of your GitLab production If you need to run some Ruby code in the context of your GitLab production
environment, you can do so using the [Rails Runner](https://guides.rubyonrails.org/command_line.html#rails-runner). environment, you can do so using the [Rails Runner](https://guides.rubyonrails.org/command_line.html#rails-runner). When executing a script file, the script must be accessible by the `git` user.
**For Omnibus installations** **For Omnibus installations**
...@@ -72,6 +72,9 @@ sudo gitlab-rails runner "RAILS_COMMAND" ...@@ -72,6 +72,9 @@ sudo gitlab-rails runner "RAILS_COMMAND"
# Example with a two-line Ruby script # Example with a two-line Ruby script
sudo gitlab-rails runner "user = User.first; puts user.username" sudo gitlab-rails runner "user = User.first; puts user.username"
# Example with a ruby script file
sudo gitlab-rails runner /path/to/script.rb
``` ```
**For installations from source** **For installations from source**
...@@ -81,6 +84,9 @@ sudo -u git -H bundle exec rails runner -e production "RAILS_COMMAND" ...@@ -81,6 +84,9 @@ sudo -u git -H bundle exec rails runner -e production "RAILS_COMMAND"
# Example with a two-line Ruby script # Example with a two-line Ruby script
sudo -u git -H bundle exec rails runner -e production "user = User.first; puts user.username" sudo -u git -H bundle exec rails runner -e production "user = User.first; puts user.username"
# Example with a ruby script file
sudo -u git -H bundle exec rails runner -e production /path/to/script.rb
``` ```
## Mail not working ## Mail not working
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment