Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found
Select Git revision
  • develop
  • master
  • renovate/configure
  • v0.1.0
  • v0.2.0
  • v0.3.0
  • v0.4.0
  • v0.5.0
8 results

Target

Select target project
  • macrominds/website
1 result
Select Git revision
  • develop
  • master
  • renovate/configure
  • v0.1.0
  • v0.2.0
  • v0.3.0
  • v0.4.0
  • v0.5.0
8 results
Show changes
Commits on Source (5)
Hide whitespace changes
Inline Side-by-side
CHANGELOG.md
View file @ b970af2f
......@@ -3,6 +3,10 @@
All noteable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
## [0.2.0] – 2019-12-12 „Automatic Ant“
- Added automatic deployment
## [0.1.0] – 2019-11-30 „Reborn Chilled“
Initial version of this standalone website project skeleton
......
README.md
View file @ b970af2f
......@@ -113,6 +113,114 @@ You can specify to treat the markdown section as a Twig template, by setting the
This very basic documentation will be complemented soon.
## Deployment
### Server system requirements
You need php 7.3 and mod_rewrite. Composer and ssh access are required for auto deployment.
### Provisioning tools
I recommend using Uberspace.
See https://gitlab.com/macrominds/provision/uberspace for ansible roles
that are specially tailored for Uberspace and macrominds/website.
You can combine them as follows. Configure ssh access for your Uberspace and
run `ansible-playbook -i my-website, site.yml` to provision it.
Most likely, I will provide a detailed example project soon.
site.yml:
```yaml
---
- hosts: all
roles:
- role: lib-webp
- role: web-domains
web_domains_list:
- my-website.com
- www.my-website.com
- role: mail-domains
mail_domains_list:
- my-website.com
- role: web-prerequisites
- role: web-link-html-to-deployer-target
- role: web-provide-shared-deployer-dot-env
```
An Uberspace server, provisioned that way, is ready to be used for auto deployment.
### Manual deployment
You can delete [deploy.php](deploy.php) and [hosts.yml](hosts.yml) if you don't plan to use auto deployment.
In that case, you can also run `composer remove deployer/deployer deployer/recipes`.
Don't forget to set your document root after having performed the steps of either
„Pure manual deployment“ or „Manual deployment with composer“ for the first time.
#### Pure manual deployment
For pure manual deployment, run `composer install --no-dev --optimize-autoloader` locally.
Afterwards upload the following files and folders:
* content
* templates
* public
* vendor
* .env **But make sure to adapt it to production settings**: `APP_ENV=production`
#### Manual deployment with composer
You can delete [deploy.php](deploy.php) and [hosts.yml](hosts.yml) if you don't plan to use auto deployment.
If you have Composer and ssh access, then upload
* content
* templates
* public
* composer.json
* composer.lock
* .env **But make sure to adapt it to production settings**: `APP_ENV=production`
On the server, run `composer install --no-dev --optimize-autoloader`.
### Set your document root
Make [public](public) your document root.
TIP: If you cannot easily modify your document root, try a symlink (e.g. `ln -sfn website/public docroot`).
### Auto deployment
We're using [Deployer](https://deployer.org/) for auto deployment.
#### Preparations
Edit [hosts.yml](hosts.yml) to match your git `repository` and `application` name.
The keys `testing` and `prod` are server names. Either configure your ssh servers (~/.ssh/config) to match
the names or rename the keys to your server(s). E.g. replace `prod` with `my-website.com`. Of course,
you will still need to configure ssh for `my-website.com`.
If you are using an Uberspace, uncomment the following part of your [deploy.php](deploy.php).
It is required as a work around for caching problems on the Uberspace.
```php
task('uberspace:reload', function() {
run('uberspace tools restart php');
});
after('cleanup', 'uberspace:reload');
```
### Run the auto deployment
Run `vendor/bin/dep deploy {server-name}`, and replace `{server-name}` by one of your
configured servers.
E.g. run `vendor/bin/dep deploy prod` if you haven't changed the name of it in
[hosts.yml](hosts.yml).
## TODO
* Adapt composer.json content (and maybe more templates) to the new project's name
......
composer.json
View file @ b970af2f
......@@ -10,5 +10,9 @@
"post-root-package-install": [
"@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
]
},
"require-dev": {
"deployer/deployer": "^6.6",
"deployer/recipes": "^6.2"
}
}
composer.lock
View file @ b970af2f
......@@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "2154730af3230a9bec36da5faf512381",
"content-hash": "cd1a0f50c07787bd748a9d9eef34c972",
"packages": [
{
"name": "erusev/parsedown",
......@@ -1144,7 +1144,414 @@
"time": "2019-09-10T21:37:39+00:00"
}
],
"packages-dev": [],
"packages-dev": [
{
"name": "deployer/deployer",
"version": "v6.6.0",
"source": {
"type": "git",
"url": "https://github.com/deployphp/deployer.git",
"reference": "74b3f73e60acee2eccc0d53c270a7c4335d5b5a7"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/deployphp/deployer/zipball/74b3f73e60acee2eccc0d53c270a7c4335d5b5a7",
"reference": "74b3f73e60acee2eccc0d53c270a7c4335d5b5a7",
"shasum": ""
},
"require": {
"deployer/phar-update": "~2.1",
"php": "~7.0",
"pimple/pimple": "~3.0",
"symfony/console": "~2.7|~3.0|~4.0",
"symfony/process": "~2.7|~3.0|~4.0",
"symfony/yaml": "~2.7|~3.0|~4.0"
},
"require-dev": {
"phpunit/phpunit": "^6.4.3"
},
"bin": [
"bin/dep"
],
"type": "library",
"autoload": {
"psr-4": {
"Deployer\\": "src/"
},
"files": [
"src/Support/helpers.php",
"src/functions.php"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Anton Medvedev",
"email": "anton@medv.io"
}
],
"description": "Deployment Tool",
"homepage": "https://deployer.org",
"time": "2019-11-06T17:19:15+00:00"
},
{
"name": "deployer/phar-update",
"version": "v2.1.0",
"source": {
"type": "git",
"url": "https://github.com/deployphp/phar-update.git",
"reference": "a6c7c3a1b2eb6983ebeb59cd1dc1c2e9df115c4a"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/deployphp/phar-update/zipball/a6c7c3a1b2eb6983ebeb59cd1dc1c2e9df115c4a",
"reference": "a6c7c3a1b2eb6983ebeb59cd1dc1c2e9df115c4a",
"shasum": ""
},
"require": {
"php": ">=5.3.3",
"symfony/console": "~2.7|~3.0|~4.0"
},
"require-dev": {
"mikey179/vfsstream": "1.1.0",
"phpunit/phpunit": "3.7.*",
"symfony/process": "~2.7|~3.0|~4.0"
},
"type": "library",
"autoload": {
"psr-4": {
"Deployer\\Component\\PharUpdate\\": "src/",
"Deployer\\Component\\PHPUnit\\": "src/PHPUnit/",
"Deployer\\Component\\Version\\": "src/Version/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Kevin Herrera",
"email": "kevin@herrera.io",
"homepage": "http://kevin.herrera.io"
},
{
"name": "Anton Medvedev",
"email": "anton@medv.io",
"homepage": "https://medv.io"
}
],
"description": "Integrates Phar Update to Symfony Console.",
"homepage": "https://github.com/deployphp/phar-update",
"keywords": [
"console",
"phar",
"update"
],
"time": "2018-02-27T17:29:10+00:00"
},
{
"name": "deployer/recipes",
"version": "6.2.2",
"source": {
"type": "git",
"url": "https://github.com/deployphp/recipes.git",
"reference": "84b3229c518c094a950e1fe785b7b8f9598770fe"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/deployphp/recipes/zipball/84b3229c518c094a950e1fe785b7b8f9598770fe",
"reference": "84b3229c518c094a950e1fe785b7b8f9598770fe",
"shasum": ""
},
"require": {
"php": "~7.0"
},
"replace": {
"deployer/recipes": "self.version"
},
"require-dev": {
"deployer/deployer": "^6.3"
},
"type": "library",
"autoload": {
"files": [
"autoload.php"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Anton Medvedev",
"email": "anton@medv.io"
}
],
"description": "3rd party deployer recipes",
"homepage": "https://github.com/deployphp/recipes",
"keywords": [
"cachetool",
"cloudflare",
"deploy",
"deployer",
"deployment",
"hipchat",
"newrelic",
"rabbit",
"recipes",
"sentry",
"slack",
"yarn"
],
"time": "2019-06-27T06:47:18+00:00"
},
{
"name": "symfony/console",
"version": "v4.4.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/console.git",
"reference": "f0aea3df20d15635b3cb9730ca5eea1c65b7f201"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/console/zipball/f0aea3df20d15635b3cb9730ca5eea1c65b7f201",
"reference": "f0aea3df20d15635b3cb9730ca5eea1c65b7f201",
"shasum": ""
},
"require": {
"php": "^7.1.3",
"symfony/polyfill-mbstring": "~1.0",
"symfony/polyfill-php73": "^1.8",
"symfony/service-contracts": "^1.1|^2"
},
"conflict": {
"symfony/dependency-injection": "<3.4",
"symfony/event-dispatcher": "<4.3|>=5",
"symfony/lock": "<4.4",
"symfony/process": "<3.3"
},
"provide": {
"psr/log-implementation": "1.0"
},
"require-dev": {
"psr/log": "~1.0",
"symfony/config": "^3.4|^4.0|^5.0",
"symfony/dependency-injection": "^3.4|^4.0|^5.0",
"symfony/event-dispatcher": "^4.3",
"symfony/lock": "^4.4|^5.0",
"symfony/process": "^3.4|^4.0|^5.0",
"symfony/var-dumper": "^4.3|^5.0"
},
"suggest": {
"psr/log": "For using the console logger",
"symfony/event-dispatcher": "",
"symfony/lock": "",
"symfony/process": ""
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "4.4-dev"
}
},
"autoload": {
"psr-4": {
"Symfony\\Component\\Console\\": ""
},
"exclude-from-classmap": [
"/Tests/"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Fabien Potencier",
"email": "fabien@symfony.com"
},
{
"name": "Symfony Community",
"homepage": "https://symfony.com/contributors"
}
],
"description": "Symfony Console Component",
"homepage": "https://symfony.com",
"time": "2019-12-01T10:06:17+00:00"
},
{
"name": "symfony/polyfill-php73",
"version": "v1.13.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/polyfill-php73.git",
"reference": "4b0e2222c55a25b4541305a053013d5647d3a25f"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/polyfill-php73/zipball/4b0e2222c55a25b4541305a053013d5647d3a25f",
"reference": "4b0e2222c55a25b4541305a053013d5647d3a25f",
"shasum": ""
},
"require": {
"php": ">=5.3.3"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.13-dev"
}
},
"autoload": {
"psr-4": {
"Symfony\\Polyfill\\Php73\\": ""
},
"files": [
"bootstrap.php"
],
"classmap": [
"Resources/stubs"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Nicolas Grekas",
"email": "p@tchwork.com"
},
{
"name": "Symfony Community",
"homepage": "https://symfony.com/contributors"
}
],
"description": "Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions",
"homepage": "https://symfony.com",
"keywords": [
"compatibility",
"polyfill",
"portable",
"shim"
],
"time": "2019-11-27T16:25:15+00:00"
},
{
"name": "symfony/process",
"version": "v4.4.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/process.git",
"reference": "51c0135ef3f44c5803b33dc60e96bf4f77752726"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/process/zipball/51c0135ef3f44c5803b33dc60e96bf4f77752726",
"reference": "51c0135ef3f44c5803b33dc60e96bf4f77752726",
"shasum": ""
},
"require": {
"php": "^7.1.3"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "4.4-dev"
}
},
"autoload": {
"psr-4": {
"Symfony\\Component\\Process\\": ""
},
"exclude-from-classmap": [
"/Tests/"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Fabien Potencier",
"email": "fabien@symfony.com"
},
{
"name": "Symfony Community",
"homepage": "https://symfony.com/contributors"
}
],
"description": "Symfony Process Component",
"homepage": "https://symfony.com",
"time": "2019-11-28T13:33:56+00:00"
},
{
"name": "symfony/service-contracts",
"version": "v2.0.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/service-contracts.git",
"reference": "144c5e51266b281231e947b51223ba14acf1a749"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/service-contracts/zipball/144c5e51266b281231e947b51223ba14acf1a749",
"reference": "144c5e51266b281231e947b51223ba14acf1a749",
"shasum": ""
},
"require": {
"php": "^7.2.5",
"psr/container": "^1.0"
},
"suggest": {
"symfony/service-implementation": ""
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "2.0-dev"
}
},
"autoload": {
"psr-4": {
"Symfony\\Contracts\\Service\\": ""
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Nicolas Grekas",
"email": "p@tchwork.com"
},
{
"name": "Symfony Community",
"homepage": "https://symfony.com/contributors"
}
],
"description": "Generic abstractions related to writing services",
"homepage": "https://symfony.com",
"keywords": [
"abstractions",
"contracts",
"decoupling",
"interfaces",
"interoperability",
"standards"
],
"time": "2019-11-18T17:27:11+00:00"
}
],
"aliases": [],
"minimum-stability": "stable",
"stability-flags": [],
......
deploy.php 0 → 100644
View file @ b970af2f
<?php
namespace Deployer;
require 'recipe/common.php';
// require 'recipe/npm.php';
set('allow_anonymous_stats', false);
// [Optional] Allocate tty for git clone. Default value is false.
set('git_tty', true);
// Shared files/dirs between deploys
set('shared_files', []);
set('shared_dirs', []);
// Writable dirs by web server
set('writable_dirs', []);
// Hosts
inventory('hosts.yml');
// Tasks
desc('Deploy your project');
task('deploy', [
'deploy:info',
'set:remote_user',
'deploy:prepare',
'deploy:lock',
'deploy:release',
'deploy:update_code',
'deploy:shared',
'deploy:writable',
'deploy:vendors',
'deploy:clear_paths',
'deploy:symlink',
'deploy:unlock',
'cleanup',
'success'
]);
desc('Set remote user');
task('set:remote_user', function() {
set('remote_user', run('whoami'));
});
// [Optional] If deploy fails automatically unlock.
after('deploy:failed', 'deploy:unlock');
// Uncomment to run "npm install && npm run production" during deployment
//desc('Run npm build process');
//task('npm:build', function () {
// run('cd {{release_path}} && {{bin/npm}} run production');
//});
//
//desc('Run npm processes');
//task('npm', [
// 'npm:install',
// 'npm:build',
//]);
//
//after('deploy:vendors', 'npm');
// If you are using an Uberspace, see https://gitlab.com/macrominds/provision/uberspace for provisioning helpers
// There's a problem with Uberspace, somehow, after the successful deployment, the change is not noticed by
// php. You need to `uberspace tools restart php`. This is not necessary when you edit a file on the
// server, or when you upload a new version of a file. But using the deployer, it is necessary.
// This might have to do with the deployer checking out in a new directory and then just
// pointing the `current` symlink to the new release. Maybe this change in the symlink
// src is too less to be noticed. It doesn't help to touch any of the symlinks or
// folders. Tried it with html, current, releases, releases/{n},
// releases/{n}/public, current/public and
// current/public/index.php.
//
// Turning off the opcache doesn't help neither.
// Tried that with ~/etc/php.d/disable-opcache.ini:
// opcache.enable = 0
//
// Uncomment this workaround if you are working with an Uberspace:
//task('uberspace:reload', function() {
// run('uberspace tools restart php');
//});
//after('cleanup', 'uberspace:reload');
hosts.yml 0 → 100644
View file @ b970af2f
---
# common settings go here
.common: &common
custom_git_path: 'macrominds/website'
# works for public repos only:
repository: 'https://gitlab.com/{{ custom_git_path }}.git'
# uncomment for ssh configured private gitlab repos:
# repository: 'git@gitlab.com:{{ custom_git_path }}.git'
forwardAgent: false
roles: app
shared_dirs:
- 'log'
shared_files:
- '.env'
application: 'website'
# remote_user will be determined via remote run of whoami
custom_sub_path: '{{ remote_user }}'
# You may very well hardcode the custom_sub_path like this:
# custom_sub_path: 'my-folder'
# All settings can also be customized per host if you want
deploy_path: '/var/www/virtual/{{ custom_sub_path }}'
# Testing deployment
testing:
<<: *common
stage: test
# Deploy the current branch.
# If you want to deploy a certain branch, uncomment and adapt the following line
# branch: master
# Production deployment
prod:
<<: *common
stage: prod
branch: master