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

Add LOGO magic to many contents and update.sh

This commit is contained in:
Tianon Gravi 2014-09-26 17:22:36 -06:00
parent 2f0c63f669
commit 7d3134f982
22 changed files with 63 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
buildpack-deps/content.md
View File

@ -7,8 +7,10 @@ things like Ruby Gems, PyPI modules, etc. For example, `buildpack-deps` would
let you do a `bundle install` in an arbitrary application directory without
knowing beforehand that `ssl.h` is required to build a dependent module.
%%LOGO%%
# How to use this image
This stack is designed to be the foundation of a language-stack image.
<!-- TODO: add an example -->
<!-- TODO: add an example -->

2
clojure/content.md
View File

@ -7,6 +7,8 @@ other Lisps, Clojure treats code as data and has a macro system.
> [wikipedia.org/wiki/Clojure](http://en.wikipedia.org/wiki/Clojure)
%%LOGO%%
# How to use this image
## Start a Lein/Clojure instance in your app

2
gcc/content.md
View File

@ -8,6 +8,8 @@ growth of free software, as both a tool and an example.
> [wikipedia.org/wiki/GNU_Compiler_Collection](https://en.wikipedia.org/wiki/GNU_Compiler_Collection)
%%LOGO%%
# How to use this image
## Start a GCC instance running your app

2
golang/content.md
View File

@ -8,6 +8,8 @@ key-value maps), and a large standard library.
> [wikipedia.org/wiki/Go_(programming_language)](http://en.wikipedia.org/wiki/Go_(programming_language))
%%LOGO%%
# How to use this image
## Start a Go instance in your app

4
hello-world/content.md
View File

@ -21,4 +21,6 @@
$ docker images hello-world
REPOSITORY TAG IMAGE ID VIRTUAL SIZE
hello-world latest 565a9d68a73f 922 B
hello-world latest f86750113cd2 910 B
%%LOGO%%

2
hylang/content.md
View File

@ -10,6 +10,8 @@ the data structure of both into Python's AST.
> [wikipedia.org/wiki/Hy](https://en.wikipedia.org/wiki/Hy)
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Hy project

2
java/content.md
View File

@ -9,6 +9,8 @@ Java is a registered trademark of Oracle and/or its affiliates.
> [wikipedia.org/wiki/Java_(programming_language)](http://en.wikipedia.org/wiki/Java_(programming_language))
%%LOGO%%
# How to use this image
## Start a Java instance in your app

2
jruby/content.md
View File

@ -16,6 +16,8 @@ Ruby that you already know and love.
With JRuby you are able to take advantage of real native threads, enhanced
garbage collection, and even import and use java libraries.
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Ruby app project

5
mongo/content.md
View File

@ -6,15 +6,20 @@ First developed by the software company 10gen (now MongoDB Inc.) in October 2007
> [wikipedia.org/wiki/MongoDB](https://en.wikipedia.org/wiki/MongoDB)
%%LOGO%%
# How to use this image
## start a mongo instance
docker run --name some-mongo -d mongo
This image includes `EXPOSE 27017` (the mongo port), so standard container linking will make it automatically available to the linked containers (as the following examples illustrate).
## connect to it from an application
docker run --name some-app --link some-mongo:mongo -d application-that-uses-mongo
## ... or via `mongo`
docker run -it --link some-mongo:mongo --rm mongo sh -c 'exec mongo "$MONGO_PORT_27017_TCP_ADDR:$MONGO_PORT_27017_TCP_PORT/test"'

2
mysql/content.md
View File

@ -8,6 +8,8 @@ Oracle Corporation and/or affiliates own the copyright and trademark for MySQL.
> [wikipedia.org/wiki/MySQL](https://en.wikipedia.org/wiki/MySQL)
%%LOGO%%
# How to use this image
## start a mysql instance

2
nginx/content.md
View File

@ -4,6 +4,8 @@ Nginx (pronounced "engine-x") is an open source reverse proxy server for HTTP, H
> [wikipedia.org/wiki/Nginx](https://en.wikipedia.org/wiki/Nginx)
%%LOGO%%
# How to use this image
## hosting some simple static content

2
node/content.md
View File

@ -18,6 +18,8 @@ software such as Apache.
> [wikipedia.org/wiki/Node.js](https://en.wikipedia.org/wiki/Node.js)
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Node.js app project

2
perl/content.md
View File

@ -6,6 +6,8 @@ including C, shell scripting (sh), AWK, and sed.
> [wikipedia.org/wiki/Perl](https://en.wikipedia.org/wiki/Perl)
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Perl app project

2
php/content.md
View File

@ -9,6 +9,8 @@ interface (CGI).
> [wikipedia.org/wiki/PHP](http://en.wikipedia.org/wiki/PHP)
%%LOGO%%
# How to use this image.
## With Command Line

6
postgres/content.md
View File

@ -1,20 +1,26 @@
# What is PostgreSQL?
PostgreSQL, often simply "Postgres", is an object-relational database management system (ORDBMS) with an emphasis on extensibility and standards-compliance. As a database server, its primary function is to store data, securely and supporting best practices, and retrieve it later, as requested by other software applications, be it those on the same computer or those running on another computer across a network (including the Internet). It can handle workloads ranging from small single-machine applications to large Internet-facing applications with many concurrent users. Recent versions also provide replication of the database itself for security and scalability.
PostgreSQL implements the majority of the SQL:2011 standard, is ACID-compliant and transactional (including most DDL statements) avoiding locking issues using multiversion concurrency control (MVCC), provides immunity to dirty reads and full serializability; handles complex SQL queries using many indexing methods that are not available in other databases; has updateable views and materialized views, triggers, foreign keys; supports functions and stored procedures, and other expandability, and has a large number of extensions written by third parties. In addition to the possibility of working with the major proprietary and open source databases, PostgreSQL supports migration from them, by its extensive standard SQL support and available migration tools. And if proprietary extensions had been used, by its extensibility that can emulate many through some built-in and third-party open source compatibility extensions, such as for Oracle.
> [wikipedia.org/wiki/PostgreSQL](https://en.wikipedia.org/wiki/PostgreSQL)
%%LOGO%%
# How to use this image
## start a postgres instance
docker run --name some-postgres -d postgres
This image includes `EXPOSE 5432` (the postgres port), so standard container linking will make it automatically available to the linked containers. The default `postgres` user and database are created in the entrypoint with `initdb`.
> The postgres database is a default database meant for use by users, utilities and third party applications. [postgresql.org/docs](http://www.postgresql.org/docs/9.3/interactive/app-initdb.html)
## connect to it from an application
docker run --name some-app --link some-postgres:postgres -d application-that-uses-postgres
## ... or via `psql`
docker run -it --link some-postgres:postgres --rm postgres sh -c 'exec psql -h "$POSTGRES_PORT_5432_TCP_ADDR" -p "$POSTGRES_PORT_5432_TCP_PORT" -U postgres'

2
python/content.md
View File

@ -11,6 +11,8 @@ Windows 2000 and later.
> [wikipedia.org/wiki/Python_(programming_language)](https://en.wikipedia.org/wiki/Python_(programming_language))
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Python app project

2
rails/content.md
View File

@ -9,6 +9,8 @@ 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

6
redis/content.md
View File

@ -1,11 +1,15 @@
# What is Redis?
Redis is an open-source, networked, in-memory, key-value data store with optional durability. It is written in ANSI C. The development of Redis has been sponsored by Pivotal since May 2013; before that, it was sponsored by VMware. According to the monthly ranking by DB-Engines.com, Redis is the most popular key-value store. The name Redis means REmote DIctionary Server.
> [wikipedia.org/wiki/Redis](https://en.wikipedia.org/wiki/Redis)
%%LOGO%%
# How to use this image
## start a redis instance
docker run --name some-redis -d redis
This image includes `EXPOSE 6379` (the redis port), so standard container linking will make it automatically available to the linked containers (as the following examples illustrate).
@ -19,9 +23,11 @@ If persistence is enabled, data is stored in the `VOLUME /data`, which can be us
For more about Redis Persistence, see [http://redis.io/topics/persistence](http://redis.io/topics/persistence).
## connect to it from an application
docker run --name some-app --link some-redis:redis -d application-that-uses-redis
## ... or via `redis-cli`
docker run -it --link some-redis:redis --rm redis sh -c 'exec redis-cli -h "$REDIS_PORT_6379_TCP_ADDR" -p "$REDIS_PORT_6379_TCP_PORT"'
## Additionally, If you want to use your own redis.conf ...

2
ruby/content.md
View File

@ -8,6 +8,8 @@ type system and automatic memory management.
> [wikipedia.org/wiki/Ruby_(programming_language)](https://en.wikipedia.org/wiki/Ruby_(programming_language))
%%LOGO%%
# How to use this image
## Create a `Dockerfile` in your Ruby app project

13
ubuntu/content.md
View File

@ -61,16 +61,3 @@ As of April 18 2014 these images are based on the official Ubuntu Minimal packag
deb-src http://archive.ubuntu.com/ubuntu/ precise-security main restricted
deb http://archive.ubuntu.com/ubuntu/ precise-security universe
deb-src http://archive.ubuntu.com/ubuntu/ precise-security universe
## Issues
If you run into any problems with this image, please check (and potentially file new) [issues on the tianon/docker-brew-ubuntu-core repo](https://github.com/tianon/docker-brew-ubuntu-core/issues), which is the source for this image.
## Installed packages
* [lucid (10.04) minimal](http://packages.ubuntu.com/trusty/ubuntu-minimal)
* [precise (12.04) minimal](http://packages.ubuntu.com/trusty/ubuntu-minimal)
* [quantal (12.10) minimal](http://packages.ubuntu.com/trusty/ubuntu-minimal)
* [raring (13.04) minimal](http://packages.ubuntu.com/trusty/ubuntu-minimal)
* [saucy (13.10) minimal](http://packages.ubuntu.com/trusty/ubuntu-minimal)
* [trusty (14.04) minimal](http://packages.ubuntu.com/trusty/ubuntu-minimal)

9
update.sh
View File

@ -65,6 +65,11 @@ for repo in "${repos[@]}"; do
license=$'\n\n''# License'$'\n\n'"$license"
fi
logo=
if [ -e "$repo/logo.png" ]; then
logo="![logo](https://raw.githubusercontent.com/docker-library/docs/master/$repo/logo.png)"
fi
cp -v README-template.md "$repo/README.md"
echo ' TAGS => ./generate-dockerfile-links-partial.sh'
@ -73,6 +78,10 @@ for repo in "${repos[@]}"; do
echo ' CONTENT => '"$repo"'/content.md'
replace_field "$repo" 'CONTENT' "$(cat "$repo/content.md")"
# has to be after CONTENT because it's contained in content.md
echo " LOGO => $logo"
replace_field "$repo" 'LOGO' "$logo" '\s*'
echo ' LICENSE => '"$repo"'/license.md'
replace_field "$repo" 'LICENSE' "$license"

3
wordpress/content.md
View File

@ -1,8 +1,11 @@
# What is WordPress?
WordPress is a free and open source blogging tool and a content management system (CMS) based on PHP and MySQL, which runs on a web hosting service. Features include a plugin architecture and a template system. WordPress is used by more than 22.0% of the top 10 million websites as of August 2013. WordPress is the most popular blogging system in use on the Web, at more than 60 million websites. The most popular languages used are English, Spanish and Bahasa Indonesia.
> [wikipedia.org/wiki/WordPress](https://en.wikipedia.org/wiki/WordPress)
%%LOGO%%
# How to use this image
docker run --name some-wordpress --link some-mysql:mysql -d wordpress