-
Notifications
You must be signed in to change notification settings - Fork 441
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 documentation about Play 2 packaging as deb- and rpm-packages #427
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,3 +15,4 @@ Advanced Topics | |
docker.rst | ||
paths.rst | ||
custom.rst | ||
play.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
Play 2 Packaging | ||
================ | ||
|
||
Although Play 2 supports Sbt Native Packager, it requires some additional steps | ||
to successfully package and run your application. | ||
|
||
Build Configuration | ||
------------------- | ||
|
||
Depending on whether you want to package your application as a deb-package or | ||
as an rpm-package, you have to setup your build configuration accordingly. | ||
Please, refer to :doc:`Debian </DetailedTopics/debian>` and :doc:`Redhat </DetailedTopics/redhat>` | ||
pages for additional information. | ||
|
||
It is important to mention that you may have certain difficulties with **Upstart** | ||
service manager (i.e. inability to create necessary folders after system restart), | ||
so it is advised to use **SystemV** service manager instead. | ||
For more information on service managers please refer | ||
to :doc:`Getting Started With Servers </GettingStartedServers/index>` page. | ||
|
||
Application Configuration | ||
------------------------- | ||
|
||
In order to run your application in production you need to provide it with at least: | ||
|
||
* Location where it can store its pidfile | ||
* Production configuration | ||
|
||
One way to provide this information is create ``src/templates/etc-default`` with the following contents: | ||
|
||
.. code-block:: bash | ||
|
||
# Since play uses separate pidfile we have to provide it with a proper path | ||
-Dpidfile.path=/var/run/${{app_name}}/play.pid | ||
|
||
# Use separate configuration file for production environment | ||
-Dconfig.file=/usr/share/${{app_name}}/conf/production.conf | ||
|
||
# You may also want to include this setting if you use play evolutions | ||
-DapplyEvolutions.default=true | ||
|
||
This way you should either store your production configuration under ``${{path_to_app_name}}/conf/production.conf`` | ||
or put it under ``/usr/share/${{app_name}}/conf/production.conf`` by hand or using some configuration management system. | ||
|
||
See :doc:`adding configuration </GettingStartedServers/AddingConfiguration>` for more information on `etc-default` template. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this problem was already fixed in #381 . I would change this section to sound a bit more positive. E.g.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That definitely sounds better! I'll make that change.