Public | Automated Build

Last pushed: a month ago
Short Description
Bitnami Docker Image for Osclass
Full Description



What is Osclass?

Osclass is a php script that allows you to quickly create and manage your own free classifieds site. Using this script, you can provide free advertising for items for sale, real estate, jobs, cars... Hundreds of free classified advertising sites are using Osclass. Visit our demo and post a free ad to see Osclass in action.

https://osclass.org/

TL;DR;

Docker Compose

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-osclass/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Kubernetes

WARNING: This is a beta configuration, currently unsupported.

Get the raw URL pointing to the kubernetes.yml manifest and use kubectl to create the resources on your Kubernetes cluster like so:

$ kubectl create -f https://raw.githubusercontent.com/bitnami/bitnami-docker-osclass/master/kubernetes.yml

Why use Bitnami Images?

  • Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
  • With Bitnami images the latest bug fixes and features are available as soon as possible.
  • Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
  • Bitnami images are built on CircleCI and automatically pushed to the Docker Hub.
  • All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.

Prerequisites

To run this application you need Docker Engine >= 1.10.0. Docker Compose is recommended with a version 1.6.0 or later.

How to use this image

Osclass requires access to a MySQL database or MariaDB database to store information. We'll use our very own MariaDB image for the database requirements.

Using Docker Compose

The recommended way to run Osclass is using Docker Compose using the following docker-compose.yml template:

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - mariadb_data:/bitnami
  osclass:
    image: bitnami/osclass:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - osclass_data:/bitnami
volumes:
  mariadb_data:
    driver: local
  osclass_data:
    driver: local

Launch the containers using:

$ docker-compose up -d

Using the Docker Command Line

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

  1. Create a network

    $ docker network create osclass-tier
    
  2. Create a volume for MariaDB persistence and create a MariaDB container

    $ docker volume create --name mariadb_data
    $ docker run -d --name mariadb -e ALLOW_EMPTY_PASSWORD=yes \
     --net osclass-tier \
     --volume mariadb_data:/bitnami \
     bitnami/mariadb:latest
    
  3. Create volumes for Osclass persistence and launch the container

    $ docker volume create --name osclass_data
    $ docker run -d --name osclass -p 80:80 -p 443:443 \
     --net osclass-tier \
     --volume osclass_data:/bitnami \
     bitnami/osclass:latest
    

Access your application at http://your-ip/

NOTE:

To login to your Osclass Administration panel, go to http://your-ip/oc-admin/.

Persisting your application

If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a volume at the /bitnami path. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define docker volumes namely mariadb_data and osclass_data. The Osclass application state will persist as long as these volumes are not removed.

To avoid inadvertent removal of these volumes you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

The following docker-compose.yml template demonstrates the use of host directories as data volumes.

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - /path/to/mariadb-persistence:/bitnami
  osclass:
    image: bitnami/osclass:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - /path/to/osclass-persistence:/bitnami

Mount host directories as data volumes using the Docker command line

  1. Create a network (if it does not exist)

    $ docker network create osclass-tier
    
  2. Create a MariaDB container with host volume

    $ docker run -d --name mariadb -e ALLOW_EMPTY_PASSWORD=yes \
     --net osclass-tier \
     --volume /path/to/mariadb-persistence:/bitnami \
     bitnami/mariadb:latest
    
  3. Create the Osclass the container with host volumes

    $ docker run -d --name osclass -p 80:80 -p 443:443 \
     --net osclass-tier \
     --volume /path/to/osclass-persistence:/bitnami \
     bitnami/osclass:latest
    

Upgrading Osclass

Bitnami provides up-to-date versions of MariaDB and Osclass, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Osclass container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

  1. Get the updated images:

    $ docker pull bitnami/osclass:latest
    
  2. Stop your container

    • For docker-compose: $ docker-compose stop osclass
    • For manual execution: $ docker stop osclass
  3. Take a snapshot of the application state

$ rsync -a /path/to/osclass-persistence /path/to/osclass-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

Additionally, snapshot the MariaDB data

You can use these snapshots to restore the application state should the upgrade fail.

  1. Remove the stopped container

    • For docker-compose: $ docker-compose rm osclass
    • For manual execution: $ docker rm osclass
  2. Run the new image

    • For docker-compose: $ docker-compose start osclass
    • For manual execution (mount the directories if needed): docker run --name osclass bitnami/osclass:latest

Configuration

Environment variables

The Osclass instance can be customized by specifying environment variables on the first run. The following environment values are provided to custom Osclass:

  • OSCLASS_USERNAME: Osclass application username. Default: user
  • OSCLASS_PASSWORD: Osclass application password. Default: bitnami1
  • OSCLASS_EMAIL: Osclass application email. Default: user@example.com
  • OSCLASS_WEB_TITLE: Osclass application title. Default: Sample Web Page
  • OSCLASS_HOST: Osclass application IP or domain. Default: 127.0.0.1
  • OSCLASS_PING_ENGINES: Allow site to appear in search engines. Default: 1
  • OSCLASS_SAVE_STATS: Automatically send usage statistics and crash reports to Osclass. Default: 1
  • MARIADB_USER: Root user for the MariaDB database. Default: root
  • MARIADB_PASSWORD: Root password for the MariaDB.
  • MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
  • MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306

Specifying Environment variables using Docker Compose

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - mariadb_data:/bitnami
  osclass:
    image: bitnami/osclass:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    environment:
      - OSCLASS_PASSWORD=my_password
    volumes:
      - osclass_data:/bitnami
volumes:
  mariadb_data:
    driver: local
  osclass_data:
    driver: local

Specifying Environment variables on the Docker command line

$ docker run -d --name osclass -p 80:80 -p 443:443 \
  --net osclass-tier \
  --env OSCLASS_PASSWORD=my_password \
  --volume osclass_data:/bitnami \
  bitnami/osclass:latest

SMTP Configuration

To configure Osclass to send email using SMTP you can set the following environment variables:

  • SMTP_HOST: Host for outgoing SMTP email.
  • SMTP_PORT: Port for outgoing SMTP email.
  • SMTP_USER: User of SMTP used for authentication (likely email).
  • SMTP_PASSWORD: Password for SMTP.
  • SMTP_PROTOCOL: Secure connection protocol to use for SMTP [tls, ssl, none].

This would be an example of SMTP configuration using a GMail account:

  • docker-compose (application part):
  osclass:
    image: bitnami/osclass:latest
    ports:
      - 80:80
    environment:
      - SMTP_HOST=smtp.gmail.com
      - SMTP_PORT=587
      - SMTP_USER=your_email@gmail.com
      - SMTP_PASSWORD=your_password
      - SMTP_PROTOCOL=tls
    volumes:
      - osclass_data:/bitnami
  • For manual execution:

    $ docker run -d --name osclass -p 80:80 -p 443:443 \
      --net osclass-tier \
      -e SMTP_HOST=smtp.gmail.com \
      -e SMTP_PORT=587 \
      -e SMTP_PROTOCOL=tls \
      -e SMTP_USER=your_email@gmail.com \
      -e SMTP_PASSWORD=your_password \
      --volume osclass_data:/bitnami \
      bitnami/osclass:latest
    

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

  • Host OS and version
  • Docker version ($ docker version)
  • Output of $ docker info
  • Version of this container ($ echo $BITNAMI_IMAGE_VERSION inside the container)
  • The command you used to run the container, and any relevant output you saw (masking any sensitive information)

Community

Most real time communication happens in the #containers channel at bitnami-oss.slack.com; you can sign up at slack.oss.bitnami.com.

Discussions are archived at bitnami-oss.slackarchive.io.

License

Copyright 2016-2017 Bitnami

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Docker Pull Command
Owner
bitnami
Source Repository

Comments (0)