docker-library
/
docs
mirror of https://github.com/docker-library/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove deprecated django and rails docs

This commit is contained in:
Tianon Gravi 2017-05-19 16:01:06 -07:00
parent b303bd58d4
commit 00005112d9
16 changed files with 0 additions and 442 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
django/README-short.txt
View File

@ -1 +0,0 @@
Django is a free web application framework, written in Python.

143
django/README.md
View File

@ -1,143 +0,0 @@
<!--
********************************************************************************
WARNING:
DO NOT EDIT "django/README.md"
IT IS AUTO-GENERATED
(from the other files in "django/" combined with a set of templates)
********************************************************************************
-->
# **DEPRECATED**
This image is officially deprecated in favor of [the standard `python` image](https://hub.docker.com/_/python/), and will receive no further updates after 2016-12-31 (Dec 31, 2016). Please adjust your usage accordingly.
For most usages of this image, it was already not bringing in `django` from this image, but actually from your project's `requirements.txt`, so the only "value" being added here was the pre-installing of `mysql-client`, `postgresql-client`, and `sqlite3` for various uses of the `django` framework.
For example, a `Dockerfile` similar to the following would be a good starting point for a Django project using PostgreSQL:
```dockerfile
FROM python:3.4
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
postgresql-client \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /usr/src/app
COPY requirements.txt ./
RUN pip install -r requirements.txt
COPY . .
EXPOSE 8000
CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
```
# Supported tags and respective `Dockerfile` links
- [`1.10.4-python3`, `1.10-python3`, `1-python3`, `python3`, `1.10.4`, `1.10`, `1`, `latest` (*3.4/Dockerfile*)](https://github.com/docker-library/django/blob/d7f1d0e61cffe81d6ca9797c63fc25eba7e277db/3.4/Dockerfile)
- [`python3-onbuild`, `onbuild` (*3.4/onbuild/Dockerfile*)](https://github.com/docker-library/django/blob/4fe080675e4a85ef6ee25c811e9d3d3ef0905794/3.4/onbuild/Dockerfile)
- [`1.10.4-python2`, `1.10-python2`, `1-python2`, `python2` (*2.7/Dockerfile*)](https://github.com/docker-library/django/blob/d7f1d0e61cffe81d6ca9797c63fc25eba7e277db/2.7/Dockerfile)
- [`python2-onbuild` (*2.7/onbuild/Dockerfile*)](https://github.com/docker-library/django/blob/cecbb2bbbcb69d1b8358398eaf8d9638e3bdd447/2.7/onbuild/Dockerfile)
# Quick reference
- **Where to get help**:
[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
- **Where to file issues**:
[https://github.com/docker-library/django/issues](https://github.com/docker-library/django/issues)
- **Maintained by**:
[the Docker Community](https://github.com/docker-library/django)
- **Published image artifact details**:
[repo-info repo's `repos/django/` directory](https://github.com/docker-library/repo-info/blob/master/repos/django) ([history](https://github.com/docker-library/repo-info/commits/master/repos/django))
(image metadata, transfer size, etc)
- **Image updates**:
[official-images PRs with label `library/django`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Fdjango)
[official-images repo's `library/django` file](https://github.com/docker-library/official-images/blob/master/library/django) ([history](https://github.com/docker-library/official-images/commits/master/library/django))
- **Source of this description**:
[docs repo's `django/` directory](https://github.com/docker-library/docs/tree/master/django) ([history](https://github.com/docker-library/docs/commits/master/django))
- **Supported Docker versions**:
[the latest release](https://github.com/docker/docker/releases/latest) (down to 1.6 on a best-effort basis)
# What is Django?
Django is a free and open source web application framework, written in Python, which follows the model-view-controller architectural pattern. Django's primary goal is to ease the creation of complex, database-driven websites with an emphasis on reusability and "pluggability" of components.
> [wikipedia.org/wiki/Django_(web_framework)](https://en.wikipedia.org/wiki/Django_%28web_framework%29)
![logo](https://raw.githubusercontent.com/docker-library/docs/164cc29281655dc81242824d1b4f90b4e6d8d7eb/django/logo.png)
# How to use this image
## Create a `Dockerfile` in your Django app project
```dockerfile
FROM django:onbuild
```
Put this file in the root of your app, next to the `requirements.txt`.
This image includes multiple `ONBUILD` triggers which should cover most applications. The build will `COPY . /usr/src/app`, `RUN pip install`, `EXPOSE 8000`, and set the default command to `python manage.py runserver`.
You can then build and run the Docker image:
```console
$ docker build -t my-django-app .
$ docker run --name some-django-app -d my-django-app
```
You can test it by visiting `http://container-ip:8000` in a browser or, if you need access outside the host, on `http://localhost:8000` with the following command:
```console
$ docker run --name some-django-app -p 8000:8000 -d my-django-app
```
## Without a `Dockerfile`
Of course, if you don't want to take advantage of magical and convenient `ONBUILD` triggers, you can always just use `docker run` directly to avoid having to add a `Dockerfile` to your project.
```console
$ docker run --name some-django-app -v "$PWD":/usr/src/app -w /usr/src/app -p 8000:8000 -d django bash -c "pip install -r requirements.txt && python manage.py runserver 0.0.0.0:8000"
```
## Bootstrap a new Django Application
If you want to generate the scaffolding for a new Django project, you can do the following:
```console
$ docker run -it --rm --user "$(id -u):$(id -g)" -v "$PWD":/usr/src/app -w /usr/src/app django django-admin.py startproject mysite
```
This will create a sub-directory named `mysite` inside your current directory.
# Image Variants
The `django` images come in many flavors, each designed for a specific use case.
## `django:<version>`
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
## `django:onbuild`
This image makes building derivative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM django:onbuild` will be enough to create a stand-alone image for your project.
While the `onbuild` variant is really useful for "getting off the ground running" (zero to Dockerized in a short period of time), it's not recommended for long-term usage within a project due to the lack of control over *when* the `ONBUILD` triggers fire (see also [`docker/docker#5714`](https://github.com/docker/docker/issues/5714), [`docker/docker#8240`](https://github.com/docker/docker/issues/8240), [`docker/docker#11917`](https://github.com/docker/docker/issues/11917)).
Once you've got a handle on how your project functions within Docker, you'll probably want to adjust your `Dockerfile` to inherit from a non-`onbuild` variant and copy the commands from the `onbuild` variant `Dockerfile` (moving the `ONBUILD` lines to the end and removing the `ONBUILD` keywords) into your own file so that you have tighter control over them and more transparency for yourself and others looking at your `Dockerfile` as to what it does. This also makes it easier to add additional requirements as time goes on (such as installing more packages before performing the previously-`ONBUILD` steps).
# License
View [license information](https://github.com/django/django/blob/master/LICENSE) for the software contained in this image.

50
django/content.md
View File

@ -1,50 +0,0 @@
# What is Django?
Django is a free and open source web application framework, written in Python, which follows the model-view-controller architectural pattern. Django's primary goal is to ease the creation of complex, database-driven websites with an emphasis on reusability and "pluggability" of components.
> [wikipedia.org/wiki/Django_(web_framework)](https://en.wikipedia.org/wiki/Django_%28web_framework%29)
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Django app project
```dockerfile
FROM django:onbuild
```
Put this file in the root of your app, next to the `requirements.txt`.
This image includes multiple `ONBUILD` triggers which should cover most applications. The build will `COPY . /usr/src/app`, `RUN pip install`, `EXPOSE 8000`, and set the default command to `python manage.py runserver`.
You can then build and run the Docker image:
```console
$ docker build -t my-django-app .
$ docker run --name some-django-app -d my-django-app
```
You can test it by visiting `http://container-ip:8000` in a browser or, if you need access outside the host, on `http://localhost:8000` with the following command:
```console
$ docker run --name some-django-app -p 8000:8000 -d my-django-app
```
## Without a `Dockerfile`
Of course, if you don't want to take advantage of magical and convenient `ONBUILD` triggers, you can always just use `docker run` directly to avoid having to add a `Dockerfile` to your project.
```console
$ docker run --name some-django-app -v "$PWD":/usr/src/app -w /usr/src/app -p 8000:8000 -d django bash -c "pip install -r requirements.txt && python manage.py runserver 0.0.0.0:8000"
```
## Bootstrap a new Django Application
If you want to generate the scaffolding for a new Django project, you can do the following:
```console
$ docker run -it --rm --user "$(id -u):$(id -g)" -v "$PWD":/usr/src/app -w /usr/src/app django django-admin.py startproject mysite
```
This will create a sub-directory named `mysite` inside your current directory.

22
django/deprecated.md
View File

@ -1,22 +0,0 @@
This image is officially deprecated in favor of [the standard `python` image](https://hub.docker.com/_/python/), and will receive no further updates after 2016-12-31 (Dec 31, 2016). Please adjust your usage accordingly.
For most usages of this image, it was already not bringing in `django` from this image, but actually from your project's `requirements.txt`, so the only "value" being added here was the pre-installing of `mysql-client`, `postgresql-client`, and `sqlite3` for various uses of the `django` framework.
For example, a `Dockerfile` similar to the following would be a good starting point for a Django project using PostgreSQL:
```dockerfile
FROM python:3.4
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
postgresql-client \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /usr/src/app
COPY requirements.txt ./
RUN pip install -r requirements.txt
COPY . .
EXPOSE 8000
CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
```

1
django/github-repo
View File

@ -1 +0,0 @@
https://github.com/docker-library/django

1
django/license.md
View File

@ -1 +0,0 @@
View [license information](https://github.com/django/django/blob/master/LICENSE) for the software contained in this image.

BIN
django/logo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 28 KiB

1
django/maintainer.md
View File

@ -1 +0,0 @@
../.common-templates/maintainer-community.md

1
rails/README-short.txt
View File

@ -1 +0,0 @@
Rails is an open-source web application framework written in Ruby.

144
rails/README.md
View File

@ -1,144 +0,0 @@
<!--
********************************************************************************
WARNING:
DO NOT EDIT "rails/README.md"
IT IS AUTO-GENERATED
(from the other files in "rails/" combined with a set of templates)
********************************************************************************
-->
# **DEPRECATED**
This image is officially deprecated in favor of [the standard `ruby` image](https://hub.docker.com/_/ruby/), and will receive no further updates after 2016-12-31 (Dec 31, 2016). Please adjust your usage accordingly.
For most usages of this image, it was already not bringing in `rails` from this image, but actually from your project's `Gemfile`, so the only "value" being added here was the pre-installing of `nodejs`, `mysql-client`, `postgresql-client`, and `sqlite3` for various uses of the `rails` framework.
For example, a `Dockerfile` similar to the following would be a good starting point for a Rails project using PostgreSQL:
```dockerfile
FROM ruby:2.3
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
postgresql-client \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /usr/src/app
COPY Gemfile* ./
RUN bundle install
COPY . .
EXPOSE 3000
CMD ["rails", "server", "-b", "0.0.0.0"]
```
# Supported tags and respective `Dockerfile` links
- [`5.0.1`, `5.0`, `5`, `latest` (*Dockerfile*)](https://github.com/docker-library/rails/blob/e16e955a67f48c1e8dc0af87ba6c0b7f8302bad2/Dockerfile)
- [`onbuild` (*onbuild/Dockerfile*)](https://github.com/docker-library/rails/blob/9df9b5e6b1519faf22e1565c2caaebf7cc1c665b/onbuild/Dockerfile)
# Quick reference
- **Where to get help**:
[the Docker Community Forums](https://forums.docker.com/), [the Docker Community Slack](https://blog.docker.com/2016/11/introducing-docker-community-directory-docker-community-slack/), or [Stack Overflow](https://stackoverflow.com/search?tab=newest&q=docker)
- **Where to file issues**:
[https://github.com/docker-library/rails/issues](https://github.com/docker-library/rails/issues)
- **Maintained by**:
[the Docker Community](https://github.com/docker-library/rails)
- **Published image artifact details**:
[repo-info repo's `repos/rails/` directory](https://github.com/docker-library/repo-info/blob/master/repos/rails) ([history](https://github.com/docker-library/repo-info/commits/master/repos/rails))
(image metadata, transfer size, etc)
- **Image updates**:
[official-images PRs with label `library/rails`](https://github.com/docker-library/official-images/pulls?q=label%3Alibrary%2Frails)
[official-images repo's `library/rails` file](https://github.com/docker-library/official-images/blob/master/library/rails) ([history](https://github.com/docker-library/official-images/commits/master/library/rails))
- **Source of this description**:
[docs repo's `rails/` directory](https://github.com/docker-library/docs/tree/master/rails) ([history](https://github.com/docker-library/docs/commits/master/rails))
- **Supported Docker versions**:
[the latest release](https://github.com/docker/docker/releases/latest) (down to 1.6 on a best-effort basis)
# What is Ruby on Rails?
Ruby on Rails or, simply, Rails is an open source web application framework which runs on the Ruby programming language. It is a full-stack framework. This means that "out of the box", Rails can create pages and applications that gather information from a web server, talk to or query a database, and render templates. As a result, Rails features a routing system that is independent of the web server.
> [wikipedia.org/wiki/Ruby_on_Rails](https://en.wikipedia.org/wiki/Ruby_on_Rails)
![logo](https://raw.githubusercontent.com/docker-library/docs/01c12653951b2fe592c1f93a13b4e289ada0e3a1/rails/logo.png)
# How to use this image
## Create a `Dockerfile` in your Rails app project
```dockerfile
FROM rails:onbuild
```
Put this file in the root of your app, next to the `Gemfile`.
This image includes multiple `ONBUILD` triggers which should cover most applications. The build will `COPY . /usr/src/app`, `RUN bundle install`, `EXPOSE 3000`, and set the default command to `rails server`.
You can then build and run the Docker image:
```console
$ docker build -t my-rails-app .
$ docker run --name some-rails-app -d my-rails-app
```
You can test it by visiting `http://container-ip:3000` in a browser or, if you need access outside the host, on port 8080:
```console
$ docker run --name some-rails-app -p 8080:3000 -d my-rails-app
```
You can then go to `http://localhost:8080` or `http://host-ip:8080` in a browser.
### Generate a `Gemfile.lock`
The `onbuild` tag expects a `Gemfile.lock` in your app directory. This `docker
run` will help you generate one. Run it in the root of your app, next to the `Gemfile`:
```console
$ docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app ruby:2.1 bundle install
```
## Bootstrap a new Rails application
If you want to generate the scaffolding for a new Rails project, you can do the following:
```console
$ docker run -it --rm --user "$(id -u):$(id -g)" -v "$PWD":/usr/src/app -w /usr/src/app rails rails new --skip-bundle webapp
```
This will create a sub-directory named `webapp` inside your current directory.
# Image Variants
The `rails` images come in many flavors, each designed for a specific use case.
## `rails:<version>`
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
## `rails:onbuild`
This image makes building derivative images easier. For most use cases, creating a `Dockerfile` in the base of your project directory with the line `FROM rails:onbuild` will be enough to create a stand-alone image for your project.
While the `onbuild` variant is really useful for "getting off the ground running" (zero to Dockerized in a short period of time), it's not recommended for long-term usage within a project due to the lack of control over *when* the `ONBUILD` triggers fire (see also [`docker/docker#5714`](https://github.com/docker/docker/issues/5714), [`docker/docker#8240`](https://github.com/docker/docker/issues/8240), [`docker/docker#11917`](https://github.com/docker/docker/issues/11917)).
Once you've got a handle on how your project functions within Docker, you'll probably want to adjust your `Dockerfile` to inherit from a non-`onbuild` variant and copy the commands from the `onbuild` variant `Dockerfile` (moving the `ONBUILD` lines to the end and removing the `ONBUILD` keywords) into your own file so that you have tighter control over them and more transparency for yourself and others looking at your `Dockerfile` as to what it does. This also makes it easier to add additional requirements as time goes on (such as installing more packages before performing the previously-`ONBUILD` steps).
# License
View [license information](https://github.com/rails/rails#license) for the software contained in this image.

53
rails/content.md
View File

@ -1,53 +0,0 @@
# What is Ruby on Rails?
Ruby on Rails or, simply, Rails is an open source web application framework which runs on the Ruby programming language. It is a full-stack framework. This means that "out of the box", Rails can create pages and applications that gather information from a web server, talk to or query a database, and render templates. As a result, Rails features a routing system that is independent of the web server.
> [wikipedia.org/wiki/Ruby_on_Rails](https://en.wikipedia.org/wiki/Ruby_on_Rails)
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Rails app project
```dockerfile
FROM rails:onbuild
```
Put this file in the root of your app, next to the `Gemfile`.
This image includes multiple `ONBUILD` triggers which should cover most applications. The build will `COPY . /usr/src/app`, `RUN bundle install`, `EXPOSE 3000`, and set the default command to `rails server`.
You can then build and run the Docker image:
```console
$ docker build -t my-rails-app .
$ docker run --name some-rails-app -d my-rails-app
```
You can test it by visiting `http://container-ip:3000` in a browser or, if you need access outside the host, on port 8080:
```console
$ docker run --name some-rails-app -p 8080:3000 -d my-rails-app
```
You can then go to `http://localhost:8080` or `http://host-ip:8080` in a browser.
### Generate a `Gemfile.lock`
The `onbuild` tag expects a `Gemfile.lock` in your app directory. This `docker
run` will help you generate one. Run it in the root of your app, next to the `Gemfile`:
```console
$ docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app ruby:2.1 bundle install
```
## Bootstrap a new Rails application
If you want to generate the scaffolding for a new Rails project, you can do the following:
```console
$ docker run -it --rm --user "$(id -u):$(id -g)" -v "$PWD":/usr/src/app -w /usr/src/app rails rails new --skip-bundle webapp
```
This will create a sub-directory named `webapp` inside your current directory.

22
rails/deprecated.md
View File

@ -1,22 +0,0 @@
This image is officially deprecated in favor of [the standard `ruby` image](https://hub.docker.com/_/ruby/), and will receive no further updates after 2016-12-31 (Dec 31, 2016). Please adjust your usage accordingly.
For most usages of this image, it was already not bringing in `rails` from this image, but actually from your project's `Gemfile`, so the only "value" being added here was the pre-installing of `nodejs`, `mysql-client`, `postgresql-client`, and `sqlite3` for various uses of the `rails` framework.
For example, a `Dockerfile` similar to the following would be a good starting point for a Rails project using PostgreSQL:
```dockerfile
FROM ruby:2.3
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
postgresql-client \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /usr/src/app
COPY Gemfile* ./
RUN bundle install
COPY . .
EXPOSE 3000
CMD ["rails", "server", "-b", "0.0.0.0"]
```

1
rails/github-repo
View File

@ -1 +0,0 @@
https://github.com/docker-library/rails

1
rails/license.md
View File

@ -1 +0,0 @@
View [license information](https://github.com/rails/rails#license) for the software contained in this image.

BIN
rails/logo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 29 KiB

1
rails/maintainer.md
View File

@ -1 +0,0 @@
../.common-templates/maintainer-community.md