Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Demo Tutorial link on the GCE platform #28

Merged
merged 15 commits into from
Jan 24, 2024
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Meeds Docker image

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2FMeeds-io%2Fmeeds-docker&cloudshell_git_branch=develop&cloudshell_tutorial=gce.md)

The image is compatible with the following databases system : `MySQL` (default) / `HSQLDB` / `PostgreSQL`

![Docker Stars](https://img.shields.io/docker/stars/meedsio/meeds.svg) - ![Docker Pulls](https://img.shields.io/docker/pulls/meedsio/meeds.svg)
Expand Down
53 changes: 53 additions & 0 deletions gce-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
#
# This file is part of the Meeds project (https://meeds.io/).
# Copyright (C) 2024 Meeds Association
# [email protected]
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
version: '2'
services:
meeds:
image: ghcr.io/meeds-io/meeds/meeds-io:develop
environment:
MEEDS_PROXY_VHOST: localhost
MEEDS_PROXY_PORT: 80
MEEDS_PROXY_SSL: "false"
MEEDS_DB_NAME: meeds
MEEDS_DB_USER: meeds
MEEDS_DB_PASSWORD: my-secret-pw
MEEDS_ADDONS_LIST:
MEEDS_JVM_LOG_GC_ENABLED: "true"
MEEDS_ES_SCHEME: http
MEEDS_ES_HOST: es
MEEDS_ES_PORT: 9200
volumes:
- meeds_data:/srv/meeds
- meeds_logs:/var/log/meeds
expose:
- "8080"
ports:
- "8080:8080"
es:
image: exoplatform/elasticsearch:2.0.3
volumes:
- search_data:/usr/share/elasticsearch/data:rw
environment:
- ES_JAVA_OPTS=-Xms2048m -Xmx2048m
- node.name=meeds
- cluster.name=meeds
- cluster.initial_master_nodes=meeds
- network.host=_site_
volumes:
meeds_data:
meeds_logs:
search_data:
42 changes: 42 additions & 0 deletions gce.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# How to run?

## Getting started

Welcome to the Meeds-io Startup tutorial. Here we will show you how to run Meeds in a few steps. To get started, click on Start!

## VM Setup
Elasticsearch uses a mmapfs directory by default to store its indices. The default operating system limits on mmap counts are likely to be too low, which may result in out-of-memory exceptions. See [doc](https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html).
```bash
sudo sysctl -w vm.max_map_count=262144
```
## Start Meeds
```bash
docker-compose -f gce-compose.yml -p demo up -d
docker-compose -f gce-compose.yml -p demo logs -f meeds
```

Wait for Meeds's startup. A log message should appear:
```
| INFO | Server startup in [XXXXX] milliseconds [org.apache.catalina.startup.Catalina<main>]
```
After Meeds startup. Click on `Web preview` <walkthrough-web-preview-icon></walkthrough-web-preview-icon> Button and click on `Preview on Port 8080`. Enjoy!

## Stop Meeds
Hope you enjoyed Meeds. You can tear down the server by following one of these options:
- To stop Meeds without removing docker containers:
```bash
docker-compose -f gce-compose.yml -p demo stop
```
- To stop Meeds by removing docker containers:
```bash
docker-compose -f gce-compose.yml -p demo down
```
- To stop Meeds by removing docker containers and volumes:
```bash
docker-compose -f gce-compose.yml -p demo down -v
```
You can start again meeds by following the previous step.

You can check out our Github [organization](https://github.com/Meeds-io) and our [builders hub](https://builders.meeds.io).

That's all :)