Merge pull request #120 from odoo/master

[ADD] Odoo documentation
This commit is contained in:
Tianon Gravi 2015-01-09 09:59:26 -07:00
commit 32d18eb655
6 changed files with 189 additions and 0 deletions

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

@ -0,0 +1 @@
Odoo (formerly known as OpenERP) is a suite of open-source business apps.

111
odoo/README.md Normal file
View File

@ -0,0 +1,111 @@
# Supported tags and respective `Dockerfile` links
- [`8.0`, `8`, `latest` (*8.0/Dockerfile*)](https://github.com/odoo/docker/blob/0c90527ef908add1f125406a81519f9626d982d3/8.0/Dockerfile)
For more information about this image and its history, please see the [relevant
manifest file
(`library/odoo`)](https://github.com/docker-library/official-images/blob/master/library/odoo)
in the [`docker-library/official-images` GitHub
repo](https://github.com/docker-library/official-images).
# What is Odoo?
Odoo, formerly known as OpenERP, is a suite of open-source business apps
written in Python and released under the AGPL license. This suite of
applications covers all business needs, from Website/Ecommerce down to
manufacturing, inventory and accounting, all seamlessly integrated. It is the
first time ever a software editor managed to reach such a functional coverage.
Odoo is the most installed business software in the world. Odoo is used by
2.000.000 users worldwide ranging from very small companies (1 user) to very
large ones (300 000 users).
> [www.odoo.com](https://www.odoo.com)
![logo](https://raw.githubusercontent.com/docker-library/docs/master/odoo/logo.png)
# How to use this image
This image requires a running PostgreSQL server.
## Start a PostgreSQL server
docker run -d -e POSTGRES_USER=odoo -e POSTGRES_PASSWORD=odoo --name db postgres
## Start an Odoo instance
docker run -p 127.0.0.1:8069:8069 --name odoo --link db:db -t odoo
The alias of the container running Postgres must be db for Odoo to be able
to connect to the Postgres server.
## Stop and restart an Odoo instance
docker stop odoo
docker start -a odoo
## Stop and restart a PostgreSQL server
When a PostgreSQL server is restarted, the Odoo instances
linked to that server must be restarted as well because the server address has
changed and the link is thus broken.
Restarting a PostgreSQL server does not affect the created databases.
## Run Odoo with a custom configuration
The default configuration file for the server (located at `/etc/odoo/openerp-server.conf`)
can be overriden at startup using volumes. Suppose you have a custom configuration
at `/path/to/config/openerp-server.conf`, then
docker run -v /path/to/config:/etc/odoo -p 127.0.0.1:8069:8069 --name odoo --link db:db -t odoo
## Run multiple Odoo instances
docker run -p 127.0.0.1:8070:8069 --name odoo2 --link db:db -t odoo
docker run -p 127.0.0.1:8071:8069 --name odoo3 --link db:db -t odoo
Please note that for plain use of mails and reports functionalities, when the
host and container ports differ (e.g. 8070 and 8069), one has to set,
in Odoo, Settings->Parameters->System Parameters (requires technical features),
web.base.url to the container port (e.g. 127.0.0.1:8069).
# How to upgrade this image
Suppose you created a database from an Odoo instance named old-odoo, and you
want to access this database from a new Odoo instance named new-odoo, e.g.
because you've just downloaded a newer Odoo image.
By default, Odoo 8.0 uses a filestore (located at /var/lib/odoo/.local/share/Odoo/filestore/)
for attachments. You should restore this filestore in your new Odoo instance by
running
docker run --volumes-from old-odoo -p 127.0.0.1:8070:8069 --name new-odoo --link db:db -t odoo
You can also simply prevent Odoo from using the filestore by setting the system
parameter `ir_attachment.location` to `db-storage` in Settings->Parameters->System
Parameters (requires technical features).
# License
View [license information](https://raw.githubusercontent.com/odoo/odoo/8.0/LICENSE)
for the software contained in this image.
# User Feedback
## Issues
If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/odoo/docker/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/odoo/docker/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.

74
odoo/content.md Normal file
View File

@ -0,0 +1,74 @@
# What is Odoo?
Odoo, formerly known as OpenERP, is a suite of open-source business apps
written in Python and released under the AGPL license. This suite of
applications covers all business needs, from Website/Ecommerce down to
manufacturing, inventory and accounting, all seamlessly integrated. It is the
first time ever a software editor managed to reach such a functional coverage.
Odoo is the most installed business software in the world. Odoo is used by
2.000.000 users worldwide ranging from very small companies (1 user) to very
large ones (300 000 users).
> [www.odoo.com](https://www.odoo.com)
%%LOGO%%
# How to use this image
This image requires a running PostgreSQL server.
## Start a PostgreSQL server
docker run -d -e POSTGRES_USER=odoo -e POSTGRES_PASSWORD=odoo --name db postgres
## Start an Odoo instance
docker run -p 127.0.0.1:8069:8069 --name odoo --link db:db -t odoo
The alias of the container running Postgres must be db for Odoo to be able
to connect to the Postgres server.
## Stop and restart an Odoo instance
docker stop odoo
docker start -a odoo
## Stop and restart a PostgreSQL server
When a PostgreSQL server is restarted, the Odoo instances
linked to that server must be restarted as well because the server address has
changed and the link is thus broken.
Restarting a PostgreSQL server does not affect the created databases.
## Run Odoo with a custom configuration
The default configuration file for the server (located at `/etc/odoo/openerp-server.conf`)
can be overriden at startup using volumes. Suppose you have a custom configuration
at `/path/to/config/openerp-server.conf`, then
docker run -v /path/to/config:/etc/odoo -p 127.0.0.1:8069:8069 --name odoo --link db:db -t odoo
## Run multiple Odoo instances
docker run -p 127.0.0.1:8070:8069 --name odoo2 --link db:db -t odoo
docker run -p 127.0.0.1:8071:8069 --name odoo3 --link db:db -t odoo
Please note that for plain use of mails and reports functionalities, when the
host and container ports differ (e.g. 8070 and 8069), one has to set,
in Odoo, Settings->Parameters->System Parameters (requires technical features),
web.base.url to the container port (e.g. 127.0.0.1:8069).
# How to upgrade this image
Suppose you created a database from an Odoo instance named old-odoo, and you
want to access this database from a new Odoo instance named new-odoo, e.g.
because you've just downloaded a newer Odoo image.
By default, Odoo 8.0 uses a filestore (located at /var/lib/odoo/.local/share/Odoo/filestore/)
for attachments. You should restore this filestore in your new Odoo instance by
running
docker run --volumes-from old-odoo -p 127.0.0.1:8070:8069 --name new-odoo --link db:db -t odoo
You can also simply prevent Odoo from using the filestore by setting the system
parameter `ir_attachment.location` to `db-storage` in Settings->Parameters->System
Parameters (requires technical features).

2
odoo/license.md Normal file
View File

@ -0,0 +1,2 @@
View [license information](https://raw.githubusercontent.com/odoo/odoo/8.0/LICENSE)
for the software contained in this image.

BIN
odoo/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 KiB

View File

@ -39,6 +39,7 @@ declare -A otherRepos=(
[mono]='https://github.com/mono/docker'
[neurodebian]='https://github.com/neurodebian/dockerfiles'
[nginx]='https://github.com/nginxinc/docker-nginx'
[odoo]='https://github.com/odoo/docker'
[opensuse]='https://github.com/openSUSE/docker-containers-build'
[oraclelinux]='https://github.com/oracle/docker-images'
[perl]='https://github.com/Perl/docker-perl'