Commit 63cdd7eb authored by tarator's avatar tarator
Browse files

Add resources files and documentation.

parent 05b54ef6
Pipeline #7293 passed with stages
in 3 minutes and 59 seconds
MYSQL_PASSWORD=[REPLACE_THIS_WITH_A_SECURE_PASSWORD]
MYSQL_ROOT_PASSWORD=[REPLACE_THIS_WITH_A_SECURE_PASSWORD]
\ No newline at end of file
#
# Welcome, friend. Thanks for trying out Monica. We hope you'll have fun.
#
# Two choices: local|production. Use local if you want to install Monica as a
# development version. Use production otherwise.
APP_ENV=production
# true if you want to show debug information on errors. For production, put this
# to false.
APP_DEBUG=false
# The encryption key. This is the most important part of the application. Keep
# this secure otherwise, everyone will be able to access your application.
# Must be 32 characters long exactly.
# Use `php artisan key:generate` or `echo -n 'base64:'; openssl rand -base64 32` to generate a random key.
APP_KEY=[REPLACE_THIS_WITH_A_SECURE_PASSWORD]
# Prevent information leakage by referring to IDs with hashIds instead of
# the actual IDs used in the database.
HASH_SALT=[REPLACE_THIS_WITH_A_SECURE_PASSWORD]
HASH_LENGTH=18
# The URL of your application.
APP_URL=https://monica.example.com
# Force using APP_URL as base url of your application.
# You should not need this, unless you are using subdirectory config.
APP_FORCE_URL=false
# Database information
# To keep this information secure, we urge you to change the default password
# Currently only "mysql" compatible servers are working
DB_CONNECTION=mysql
DB_HOST=db
DB_PORT=3306
# You can use mysql unix socket if available, it overrides DB_HOST and DB_PORT values.
#DB_UNIX_SOCKET=/var/run/mysqld/mysqld.sock
DB_DATABASE=monica
DB_USERNAME=usermonica
DB_PASSWORD=[REPLACE_THIS_WITH_A_SECURE_PASSWORD]
DB_PREFIX=
# Use utf8mb4 database charset format to support emoji characters
# be sure your DBMS supports utf8mb4 format
DB_USE_UTF8MB4=true
# Mail credentials used to send emails from the application.
MAIL_MAILER=smtp
MAIL_HOST=smtp.example.it
MAIL_PORT=587
MAIL_USERNAME=noreply@example.com
MAIL_PASSWORD=[REPLACE_THIS_WITH_A_SECURE_PASSWORD]
MAIL_ENCRYPTION=TLS
# Outgoing emails will be sent with these identity
MAIL_FROM_ADDRESS=noreply@example.com
MAIL_FROM_NAME="Monica Example"
# New registration notification sent to this email
APP_EMAIL_NEW_USERS_NOTIFICATION=someaddress@example.com
# Ability to disable signups on your instance.
# Can be true or false. Default to false.
APP_DISABLE_SIGNUP=false
# Enable user email verification.
APP_SIGNUP_DOUBLE_OPTIN=false
# Set trusted proxy IP addresses.
# To trust all proxies that connect directly to your server, use a "*".
# To trust one or more specific proxies that connect directly to your server,
# use a comma separated list of IP addresses.
APP_TRUSTED_PROXIES=*
# Enable automatic cloudflare trusted proxy discover
APP_TRUSTED_CLOUDFLARE=false
# Frequency of creation of new log files. Logs are written when an error occurs.
# Refer to config/logging.php for the possible values.
LOG_CHANNEL=daily
# Error tracking. Specific to hosted version on .com. You probably don't need
# those.
SENTRY_SUPPORT=false
SENTRY_LARAVEL_DSN=
# Send a daily ping to https://version.monicahq.com to check if a new version
# is available. When a new version is detected, you will have a message in the
# UI, as well as the release notes for the new changes. Can be true or false.
# Default to true.
CHECK_VERSION=true
# Cache, session, and queue parameters
# Change this only if you know what you are doing
#. Cache: database, file, memcached, redis, dynamodb
#. Session: file, cookie, database, apc, memcached, redis, array
#. Queue: sync, database, beanstalkd, sqs, redis
# If Queue is not set to 'sync', you'll have to set a queue worker
# See https://laravel.com/docs/5.7/queues#running-the-queue-worker
CACHE_DRIVER=database
SESSION_DRIVER=file
SESSION_LIFETIME=15
QUEUE_CONNECTION=sync
# If you use redis, set the redis host or ip, like:
#REDIS_HOST=redis
# Maximum allowed size for uploaded files, in kilobytes.
# Make sure this is an integer, without commas or spaces.
DEFAULT_MAX_UPLOAD_SIZE=10240
# Maximum allowed storage size per account, in megabytes.
# Make sure this is an integer, without commas or spaces.
DEFAULT_MAX_STORAGE_SIZE=512
# Default filesystem to store uploaded files.
# Possible values: public|s3
DEFAULT_FILESYSTEM=public
# AWS keys for S3 when using this storage method
AWS_KEY=
AWS_SECRET=
AWS_REGION=us-east-1
AWS_BUCKET=
AWS_SERVER=
# Set to true if you use S3 and need path style URL support for bucket access
# The default is to use virtual-hosted style URLs which may not work everywhere
S3_PATH_STYLE=
# Allow Two Factor Authentication feature on your instance
MFA_ENABLED=true
# Enable DAV support
DAV_ENABLED=true
# CLIENT ID and SECRET used for OAuth authentication
PASSPORT_PASSWORD_GRANT_CLIENT_ID=
PASSPORT_PASSWORD_GRANT_CLIENT_SECRET=
# Allow to access general statistics about your instance through a public API
# call
ALLOW_STATISTICS_THROUGH_PUBLIC_API_ACCESS=false
# Indicates that each user in the instance must comply to international policies
# like CASL or GDPR
POLICY_COMPLIANT=false
# Enable geolocation services
# This is used to translate addresses to GPS coordinates.
ENABLE_GEOLOCATION=false
# API key for geolocation services
# We use LocationIQ (https://locationiq.com/) to translate addresses to
# latitude/longitude coo0rdinates. We could use Google instead but we don't
# want to give anything to Google, ever.
# LocationIQ offers 10,000 free requests per day.
LOCATION_IQ_API_KEY=
# Enable weather on contact profile page
# Weather can only be fetched if we know longitude/latitude - this is why
# you also need to activate the geolocation service above to make it work
ENABLE_WEATHER=false
# Access to weather data from darksky api
# https://darksky.net/dev/register
# Darksky provides an api with 1000 free API calls per day
# You need to enable the weather above if you provide an API key here.
DARKSKY_API_KEY=
.env
.env.monica
data/*
# Monica Docker Container (Supervisor for Apache and Cron)
[![pipeline status](https://gitlab.projecttac.com/tarator/monica-app/badges/master/pipeline.svg)](https://gitlab.projecttac.com/tarator/monica-app/-/commits/master)
This container extends the [official Monica Docker container](https://hub.docker.com/_/monica) using supervisord to run the cron job.
The cron-job enables sending of reminder E-Mails for Monica.
The sourcecode is hosted on this [Gitlab Projecttac](https://gitlab.projecttac.com/tarator/monica-app)
To get up and running you might check this Tuorial: [Install Monica CRM with Docker-Compose, Apache Proxy and Let’s encrypt certificate on Ubuntu 18.04](https://www.abenthung.it/2021/07/28/install-monica-crm-with-docker-compose-apache-proxy-and-lets-encrypt-certificate-on-ubuntu-18-04/)
## Docker container
You can either use the prebuilt containers or build the container on your own.
### Prebuild Containers
Prebuild containers can be found on this locations.
#### Gitlab Projecttac's Container Registry
[Link to Gitlab Projecttac's Container Registry](https://gitlab.projecttac.com/tarator/monica-app/container_registry)
```
docker pull docker.abenthung.it:5000/tarator/monica-app
```
#### Docker Hub
[Link to Docker Hub](https://hub.docker.com/r/tarator/monica-app)
```
docker pull tarator/monica-app
```
### Build Container
You can build the container on your own with Docker...
```
git clone https://gitlab.projecttac.com/tarator/monica-app.git
cd monica-app
docker build -t monica-app .
```
... or build and run with docker-compose
```
git clone https://gitlab.projecttac.com/tarator/monica-app.git
cd monica-app
docker-compose up -d --build
```
\ No newline at end of file
version: "3.4"
services:
app:
image: monica-app
build: ./
depends_on:
- db
env_file: .env.monica
links:
- db
ports:
- "127.0.0.1:4046:80"
volumes:
- ./data/storage:/var/www/html/storage
restart: always
db:
image: mariadb:10.6
environment:
- MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
- MYSQL_DATABASE=monica
- MYSQL_USER=usermonica
- MYSQL_PASSWORD=${MYSQL_PASSWORD}
volumes:
- ./data/mysql:/var/lib/mysql
restart: always
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment