Add irssi official image docs!

Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
This commit is contained in:
Jessica Frazelle 2015-01-23 11:12:59 -08:00
parent 158af74eaa
commit 633afc6f79
6 changed files with 118 additions and 0 deletions

1
irssi/README-short.txt Normal file
View File

@ -0,0 +1 @@
irssi - The IRC client of the future

78
irssi/README.md Normal file
View File

@ -0,0 +1,78 @@
# Supported tags and respective `Dockerfile` links
- [`0.8.17`, `0.8`, `0`, `latest`](https://github.com/jfrazelle/irssi/blob/a79accdf9258f9c2917fcff8ea047f4bf6754cdf/Dockerfile)
For more information about this image and its history, please see the [relevant
manifest file
(`library/irssi`)](https://github.com/docker-library/official-images/blob/master/library/irssi)
in the [`docker-library/official-images` GitHub
repo](https://github.com/docker-library/official-images).
# What is irssi?
Irssi is a terminal based IRC client for UNIX systems. It also supports SILC
and ICB protocols via plugins. Some people refer to it as 'the client of the
future'.
> [irssi.org](http://irssi.org)
![logo](https://raw.githubusercontent.com/docker-library/docs/master/irssi/logo.png)
# How to use this image
Since no two users of irssi are likely to configure it exactly alike, this
image does not come with any default configuration.
Please refer to [upstream's excellent (and comprehensive)
documentation](http://irssi.org/documentation) on the subject of
configuring irssi for your needs.
Be sure to also checkout the [awesome
scripts](https://github.com/irssi/scripts.irssi.org) you can download to
customize your irssi configuration.
## Directly via bind mount
docker run -it --name my-running-irssi -e TERM \
-u $(id -u):$(id -g) -v $HOME/.irssi:/home/user/.irssi:ro \
-v /etc/localtime:/etc/localtime:ro \
irssi
# in Docker 1.5 you can use the --read-only flag
docker run -it --name my-running-irssi -e TERM \
-u $(id -u):$(id -g) -v $HOME/.irssi:/home/user/.irssi --read-only \
-v /etc/localtime:/etc/localtime \
irssi
# License
View [license information](https://github.com/irssi/irssi/blob/master/COPYING) for
the software contained in this image.
# Supported Docker versions
This image is officially supported on Docker version 1.4.1.
Support for older versions (down to 1.0) is provided on a best-effort basis.
# User Feedback
## Issues
If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/jfrazelle/irssi/issues).
You can also reach many of the official image maintainers via the
`#docker-library` IRC channel on [Freenode](https://freenode.net).
## Contributing
You are invited to contribute new features, fixes, or updates, large or small;
we are always thrilled to receive pull requests, and do our best to process them
as fast as we can.
Before you start to code, we recommend discussing your plans
through a [GitHub issue](https://github.com/jfrazelle/irssi/issues), especially for more ambitious
contributions. This gives other contributors a chance to point you in the right
direction, give you feedback on your design, and help you find out if someone
else is working on the same thing.

36
irssi/content.md Normal file
View File

@ -0,0 +1,36 @@
# What is irssi?
Irssi is a terminal based IRC client for UNIX systems. It also supports SILC
and ICB protocols via plugins. Some people refer to it as 'the client of the
future'.
> [irssi.org](http://irssi.org)
%%LOGO%%
# How to use this image
Since no two users of irssi are likely to configure it exactly alike, this
image does not come with any default configuration.
Please refer to [upstream's excellent (and comprehensive)
documentation](http://irssi.org/documentation) on the subject of
configuring irssi for your needs.
Be sure to also checkout the [awesome
scripts](https://github.com/irssi/scripts.irssi.org) you can download to
customize your irssi configuration.
## Directly via bind mount
docker run -it --name my-running-irssi -e TERM \
-u $(id -u):$(id -g) -v $HOME/.irssi:/home/user/.irssi:ro \
-v /etc/localtime:/etc/localtime:ro \
irssi
# in Docker 1.5 you can use the --read-only flag
docker run -it --name my-running-irssi -e TERM \
-u $(id -u):$(id -g) -v $HOME/.irssi:/home/user/.irssi --read-only \
-v /etc/localtime:/etc/localtime \
irssi

2
irssi/license.md Normal file
View File

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

BIN
irssi/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -33,6 +33,7 @@ declare -A otherRepos=(
[hipache]='https://github.com/dotcloud/hipache'
[hylang]='https://github.com/hylang/hy'
[iojs]='https://github.com/iojs/docker-iojs'
[irssi]='https://github.com/jfrazelle/irssi'
[jenkins]='https://github.com/cloudbees/jenkins-ci.org-docker'
[jruby]='https://github.com/cpuguy83/docker-jruby'
[mageia]='https://github.com/juanluisbaptiste/docker-brew-mageia'