Merge branch 'dev-docs-in-gdk' into 'master'
Dev docs in gdk Also see https://gitlab.com/gitlab-org/gitlab-development-kit/merge_requests/31 See merge request !1331
This commit is contained in:
commit
2fef5c1323
46
README.md
46
README.md
|
@ -66,55 +66,15 @@ Since 2011 a minor or major version of GitLab is released on the 22nd of every m
|
||||||
|
|
||||||
For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update).
|
For updating the the Omnibus installation please see the [update documentation](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/doc/update.md). For manual installations there is an [upgrader script](doc/update/upgrader.md) and there are [upgrade guides](doc/update).
|
||||||
|
|
||||||
## Run in production mode
|
|
||||||
|
|
||||||
The Installation guide contains instructions on how to download an init script and run it automatically on boot. You can also start the init script manually:
|
|
||||||
|
|
||||||
sudo service gitlab start
|
|
||||||
|
|
||||||
or by directly calling the script:
|
|
||||||
|
|
||||||
sudo /etc/init.d/gitlab start
|
|
||||||
|
|
||||||
Please login with `root` / `5iveL!fe`
|
|
||||||
|
|
||||||
## Install a development environment
|
## Install a development environment
|
||||||
|
|
||||||
We recommend setting up your development environment with [the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit).
|
We recommend setting up your development environment with [the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit).
|
||||||
If you do not use the development kit you might need to copy the example development unicorn configuration file
|
If you do not use the GitLab Development Development kit you need to install and setup all the dependencies yourself, this is a lot of work and error prone.
|
||||||
|
One small thing you also have to do when installing it yourself is to copy the example development unicorn configuration file:
|
||||||
|
|
||||||
cp config/unicorn.rb.example.development config/unicorn.rb
|
cp config/unicorn.rb.example.development config/unicorn.rb
|
||||||
|
|
||||||
## Run in development mode
|
Instructions on how to start Gitlab and how to run the tests can be found in the [development section of the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit#development).
|
||||||
|
|
||||||
Start it with [Foreman](https://github.com/ddollar/foreman)
|
|
||||||
|
|
||||||
bundle exec foreman start -p 3000
|
|
||||||
|
|
||||||
or start each component separately:
|
|
||||||
|
|
||||||
bundle exec rails s
|
|
||||||
bin/background_jobs start
|
|
||||||
|
|
||||||
And surf to [localhost:3000](http://localhost:3000/) and login with `root` / `5iveL!fe`.
|
|
||||||
|
|
||||||
## Run the tests
|
|
||||||
|
|
||||||
- Run all tests:
|
|
||||||
|
|
||||||
bundle exec rake test
|
|
||||||
|
|
||||||
- [RSpec](http://rspec.info/) unit and functional tests.
|
|
||||||
|
|
||||||
All RSpec tests: `bundle exec rake spec`
|
|
||||||
|
|
||||||
Single RSpec file: `bundle exec rspec spec/controllers/commit_controller_spec.rb`
|
|
||||||
|
|
||||||
- [Spinach](https://github.com/codegram/spinach) integration tests.
|
|
||||||
|
|
||||||
All Spinach tests: `bundle exec rake spinach`
|
|
||||||
|
|
||||||
Single Spinach test: `bundle exec spinach features/project/issues/milestones.feature`
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
|
|
@ -383,15 +383,17 @@ NOTE: Supply `SANITIZE=true` environment variable to `gitlab:check` to omit proj
|
||||||
|
|
||||||
### Initial Login
|
### Initial Login
|
||||||
|
|
||||||
Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has created an admin account for you. You can use it to log in:
|
Visit YOUR_SERVER in your web browser for your first GitLab login. The setup has created a default admin account for you. You can use it to log in:
|
||||||
|
|
||||||
root
|
root
|
||||||
5iveL!fe
|
5iveL!fe
|
||||||
|
|
||||||
**Important Note:** Please go over to your profile page and immediately change the password, so nobody can access your GitLab by using this login information later on.
|
**Important Note:** Please login to the server before exposing it to the public internet. On login you'll be prompted to change the password.
|
||||||
|
|
||||||
**Enjoy!**
|
**Enjoy!**
|
||||||
|
|
||||||
|
You can use `sudo service gitlab start` and `sudo service gitlab stop` to start and stop GitLab.
|
||||||
|
|
||||||
## Advanced Setup Tips
|
## Advanced Setup Tips
|
||||||
|
|
||||||
### Using HTTPS
|
### Using HTTPS
|
||||||
|
|
Loading…
Reference in New Issue